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 <drm/drm_mode.h>
35 #include <drm/drm_fourcc.h>
36 #include <drm/drm_modeset_lock.h>
40 struct drm_framebuffer;
41 struct drm_object_properties;
45 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
46 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
47 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
48 #define DRM_MODE_OBJECT_MODE 0xdededede
49 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
50 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
51 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
52 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
53 #define DRM_MODE_OBJECT_BRIDGE 0xbdbdbdbd
54 #define DRM_MODE_OBJECT_ANY 0
56 struct drm_mode_object {
59 struct drm_object_properties *properties;
62 #define DRM_OBJECT_MAX_PROPERTY 24
63 struct drm_object_properties {
65 uint32_t ids[DRM_OBJECT_MAX_PROPERTY];
66 uint64_t values[DRM_OBJECT_MAX_PROPERTY];
69 static inline int64_t U642I64(uint64_t val)
71 return (int64_t)*((int64_t *)&val);
73 static inline uint64_t I642U64(int64_t val)
75 return (uint64_t)*((uint64_t *)&val);
78 enum drm_connector_force {
79 DRM_FORCE_UNSPECIFIED,
81 DRM_FORCE_ON, /* force on analog part normally */
82 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
85 #include <drm/drm_modes.h>
87 enum drm_connector_status {
88 connector_status_connected = 1,
89 connector_status_disconnected = 2,
90 connector_status_unknown = 3,
95 SubPixelHorizontalRGB,
96 SubPixelHorizontalBGR,
102 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
103 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
104 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
106 * Describes a given display (e.g. CRT or flat panel) and its limitations.
108 struct drm_display_info {
109 char name[DRM_DISPLAY_INFO_LEN];
112 unsigned int width_mm;
113 unsigned int height_mm;
115 /* Clock limits FIXME: storage format */
116 unsigned int min_vfreq, max_vfreq;
117 unsigned int min_hfreq, max_hfreq;
118 unsigned int pixel_clock;
121 enum subpixel_order subpixel_order;
124 /* Mask of supported hdmi deep color modes */
125 u8 edid_hdmi_dc_modes;
130 struct drm_framebuffer_funcs {
131 /* note: use drm_framebuffer_remove() */
132 void (*destroy)(struct drm_framebuffer *framebuffer);
133 int (*create_handle)(struct drm_framebuffer *fb,
134 struct drm_file *file_priv,
135 unsigned int *handle);
137 * Optinal callback for the dirty fb ioctl.
139 * Userspace can notify the driver via this callback
140 * that a area of the framebuffer has changed and should
141 * be flushed to the display hardware.
143 * See documentation in drm_mode.h for the struct
144 * drm_mode_fb_dirty_cmd for more information as all
145 * the semantics and arguments have a one to one mapping
148 int (*dirty)(struct drm_framebuffer *framebuffer,
149 struct drm_file *file_priv, unsigned flags,
150 unsigned color, struct drm_clip_rect *clips,
154 struct drm_framebuffer {
155 struct drm_device *dev;
157 * Note that the fb is refcounted for the benefit of driver internals,
158 * for example some hw, disabling a CRTC/plane is asynchronous, and
159 * scanout does not actually complete until the next vblank. So some
160 * cleanup (like releasing the reference(s) on the backing GEM bo(s))
161 * should be deferred. In cases like this, the driver would like to
162 * hold a ref to the fb even though it has already been removed from
163 * userspace perspective.
165 struct kref refcount;
167 * Place on the dev->mode_config.fb_list, access protected by
168 * dev->mode_config.fb_lock.
170 struct list_head head;
171 struct drm_mode_object base;
172 const struct drm_framebuffer_funcs *funcs;
173 unsigned int pitches[4];
174 unsigned int offsets[4];
177 /* depth can be 15 or 16 */
181 uint32_t pixel_format; /* fourcc format */
182 struct list_head filp_head;
183 /* if you are using the helper */
184 void *helper_private;
187 struct drm_property_blob {
188 struct drm_mode_object base;
189 struct list_head head;
191 unsigned char data[];
194 struct drm_property_enum {
196 struct list_head head;
197 char name[DRM_PROP_NAME_LEN];
200 struct drm_property {
201 struct list_head head;
202 struct drm_mode_object base;
204 char name[DRM_PROP_NAME_LEN];
207 struct drm_device *dev;
209 struct list_head enum_blob_list;
212 void drm_modeset_lock_all(struct drm_device *dev);
213 void drm_modeset_unlock_all(struct drm_device *dev);
214 void drm_warn_on_modeset_not_all_locked(struct drm_device *dev);
217 struct drm_connector;
219 struct drm_pending_vblank_event;
224 * drm_crtc_funcs - control CRTCs for a given device
225 * @save: save CRTC state
226 * @restore: restore CRTC state
227 * @reset: reset CRTC after state has been invalidated (e.g. resume)
228 * @cursor_set: setup the cursor
229 * @cursor_move: move the cursor
230 * @gamma_set: specify color ramp for CRTC
231 * @destroy: deinit and free object
232 * @set_property: called when a property is changed
233 * @set_config: apply a new CRTC configuration
234 * @page_flip: initiate a page flip
236 * The drm_crtc_funcs structure is the central CRTC management structure
237 * in the DRM. Each CRTC controls one or more connectors (note that the name
238 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
239 * connectors, not just CRTs).
241 * Each driver is responsible for filling out this structure at startup time,
242 * in addition to providing other modesetting features, like i2c and DDC
245 struct drm_crtc_funcs {
246 /* Save CRTC state */
247 void (*save)(struct drm_crtc *crtc); /* suspend? */
248 /* Restore CRTC state */
249 void (*restore)(struct drm_crtc *crtc); /* resume? */
250 /* Reset CRTC state */
251 void (*reset)(struct drm_crtc *crtc);
253 /* cursor controls */
254 int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
255 uint32_t handle, uint32_t width, uint32_t height);
256 int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
257 uint32_t handle, uint32_t width, uint32_t height,
258 int32_t hot_x, int32_t hot_y);
259 int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
261 /* Set gamma on the CRTC */
262 void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
263 uint32_t start, uint32_t size);
264 /* Object destroy routine */
265 void (*destroy)(struct drm_crtc *crtc);
267 int (*set_config)(struct drm_mode_set *set);
270 * Flip to the given framebuffer. This implements the page
271 * flip ioctl described in drm_mode.h, specifically, the
272 * implementation must return immediately and block all
273 * rendering to the current fb until the flip has completed.
274 * If userspace set the event flag in the ioctl, the event
275 * argument will point to an event to send back when the flip
276 * completes, otherwise it will be NULL.
278 int (*page_flip)(struct drm_crtc *crtc,
279 struct drm_framebuffer *fb,
280 struct drm_pending_vblank_event *event,
283 int (*set_property)(struct drm_crtc *crtc,
284 struct drm_property *property, uint64_t val);
288 * drm_crtc - central CRTC control structure
289 * @dev: parent DRM device
290 * @head: list management
291 * @mutex: per-CRTC locking
292 * @base: base KMS object for ID tracking etc.
293 * @primary: primary plane for this CRTC
294 * @cursor: cursor plane for this CRTC
295 * @enabled: is this CRTC enabled?
296 * @mode: current mode timings
297 * @hwmode: mode timings as programmed to hw regs
298 * @invert_dimensions: for purposes of error checking crtc vs fb sizes,
299 * invert the width/height of the crtc. This is used if the driver
300 * is performing 90 or 270 degree rotated scanout
301 * @x: x position on screen
302 * @y: y position on screen
303 * @funcs: CRTC control functions
304 * @gamma_size: size of gamma ramp
305 * @gamma_store: gamma ramp values
306 * @framedur_ns: precise frame timing
307 * @framedur_ns: precise line timing
308 * @pixeldur_ns: precise pixel timing
309 * @helper_private: mid-layer private data
310 * @properties: property tracking for this CRTC
312 * Each CRTC may have one or more connectors associated with it. This structure
313 * allows the CRTC to be controlled.
316 struct drm_device *dev;
317 struct list_head head;
322 * This provides a read lock for the overall crtc state (mode, dpms
323 * state, ...) and a write lock for everything which can be update
324 * without a full modeset (fb, cursor data, ...)
326 struct drm_modeset_lock mutex;
328 struct drm_mode_object base;
330 /* primary and cursor planes for CRTC */
331 struct drm_plane *primary;
332 struct drm_plane *cursor;
334 /* position of cursor plane on crtc */
338 /* Temporary tracking of the old fb while a modeset is ongoing. Used
339 * by drm_mode_set_config_internal to implement correct refcounting. */
340 struct drm_framebuffer *old_fb;
344 /* Requested mode from modesetting. */
345 struct drm_display_mode mode;
347 /* Programmed mode in hw, after adjustments for encoders,
348 * crtc, panel scaling etc. Needed for timestamping etc.
350 struct drm_display_mode hwmode;
352 bool invert_dimensions;
355 const struct drm_crtc_funcs *funcs;
357 /* CRTC gamma size for reporting to userspace */
359 uint16_t *gamma_store;
361 /* Constants needed for precise vblank and swap timestamping. */
362 int framedur_ns, linedur_ns, pixeldur_ns;
364 /* if you are using the helper */
365 void *helper_private;
367 struct drm_object_properties properties;
372 * drm_connector_funcs - control connectors on a given device
373 * @dpms: set power state (see drm_crtc_funcs above)
374 * @save: save connector state
375 * @restore: restore connector state
376 * @reset: reset connector after state has been invalidated (e.g. resume)
377 * @detect: is this connector active?
378 * @fill_modes: fill mode list for this connector
379 * @set_property: property for this connector may need an update
380 * @destroy: make object go away
381 * @force: notify the driver that the connector is forced on
383 * Each CRTC may have one or more connectors attached to it. The functions
384 * below allow the core DRM code to control connectors, enumerate available modes,
387 struct drm_connector_funcs {
388 void (*dpms)(struct drm_connector *connector, int mode);
389 void (*save)(struct drm_connector *connector);
390 void (*restore)(struct drm_connector *connector);
391 void (*reset)(struct drm_connector *connector);
393 /* Check to see if anything is attached to the connector.
394 * @force is set to false whilst polling, true when checking the
395 * connector due to user request. @force can be used by the driver
396 * to avoid expensive, destructive operations during automated
399 enum drm_connector_status (*detect)(struct drm_connector *connector,
401 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
402 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
404 void (*destroy)(struct drm_connector *connector);
405 void (*force)(struct drm_connector *connector);
409 * drm_encoder_funcs - encoder controls
410 * @reset: reset state (e.g. at init or resume time)
411 * @destroy: cleanup and free associated data
413 * Encoders sit between CRTCs and connectors.
415 struct drm_encoder_funcs {
416 void (*reset)(struct drm_encoder *encoder);
417 void (*destroy)(struct drm_encoder *encoder);
420 #define DRM_CONNECTOR_MAX_ENCODER 3
423 * drm_encoder - central DRM encoder structure
424 * @dev: parent DRM device
425 * @head: list management
426 * @base: base KMS object
427 * @name: encoder name
428 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
429 * @possible_crtcs: bitmask of potential CRTC bindings
430 * @possible_clones: bitmask of potential sibling encoders for cloning
431 * @crtc: currently bound CRTC
432 * @bridge: bridge associated to the encoder
433 * @funcs: control functions
434 * @helper_private: mid-layer private data
436 * CRTCs drive pixels to encoders, which convert them into signals
437 * appropriate for a given connector or set of connectors.
440 struct drm_device *dev;
441 struct list_head head;
443 struct drm_mode_object base;
446 uint32_t possible_crtcs;
447 uint32_t possible_clones;
449 struct drm_crtc *crtc;
450 struct drm_bridge *bridge;
451 const struct drm_encoder_funcs *funcs;
452 void *helper_private;
455 /* should we poll this connector for connects and disconnects */
456 /* hot plug detectable */
457 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
458 /* poll for connections */
459 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
460 /* can cleanly poll for disconnections without flickering the screen */
461 /* DACs should rarely do this without a lot of testing */
462 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
464 #define MAX_ELD_BYTES 128
467 * drm_connector - central DRM connector control structure
468 * @dev: parent DRM device
469 * @kdev: kernel device for sysfs attributes
470 * @attr: sysfs attributes
471 * @head: list management
472 * @base: base KMS object
473 * @name: connector name
474 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
475 * @connector_type_id: index into connector type enum
476 * @interlace_allowed: can this connector handle interlaced modes?
477 * @doublescan_allowed: can this connector handle doublescan?
478 * @modes: modes available on this connector (from fill_modes() + user)
479 * @status: one of the drm_connector_status enums (connected, not, or unknown)
480 * @probed_modes: list of modes derived directly from the display
481 * @display_info: information about attached display (e.g. from EDID)
482 * @funcs: connector control functions
483 * @edid_blob_ptr: DRM property containing EDID if present
484 * @properties: property tracking for this connector
485 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
486 * @dpms: current dpms state
487 * @helper_private: mid-layer private data
488 * @force: a %DRM_FORCE_<foo> state for forced mode sets
489 * @encoder_ids: valid encoders for this connector
490 * @encoder: encoder driving this connector, if any
491 * @eld: EDID-like data, if present
492 * @dvi_dual: dual link DVI, if found
493 * @max_tmds_clock: max clock rate, if found
494 * @latency_present: AV delay info from ELD, if found
495 * @video_latency: video latency info from ELD, if found
496 * @audio_latency: audio latency info from ELD, if found
497 * @null_edid_counter: track sinks that give us all zeros for the EDID
499 * Each connector may be connected to one or more CRTCs, or may be clonable by
500 * another connector if they can share a CRTC. Each connector also has a specific
501 * position in the broader display (referred to as a 'screen' though it could
502 * span multiple monitors).
504 struct drm_connector {
505 struct drm_device *dev;
507 struct device_attribute *attr;
508 struct list_head head;
510 struct drm_mode_object base;
514 int connector_type_id;
515 bool interlace_allowed;
516 bool doublescan_allowed;
518 struct list_head modes; /* list of modes on this connector */
520 enum drm_connector_status status;
522 /* these are modes added by probing with DDC or the BIOS */
523 struct list_head probed_modes;
525 struct drm_display_info display_info;
526 const struct drm_connector_funcs *funcs;
528 struct drm_property_blob *edid_blob_ptr;
529 struct drm_object_properties properties;
531 uint8_t polled; /* DRM_CONNECTOR_POLL_* */
533 /* requested DPMS state */
536 void *helper_private;
538 /* forced on connector */
539 enum drm_connector_force force;
540 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
541 struct drm_encoder *encoder; /* currently active encoder */
544 uint8_t eld[MAX_ELD_BYTES];
546 int max_tmds_clock; /* in MHz */
547 bool latency_present[2];
548 int video_latency[2]; /* [0]: progressive, [1]: interlaced */
549 int audio_latency[2];
550 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
551 unsigned bad_edid_counter;
555 * drm_plane_funcs - driver plane control functions
556 * @update_plane: update the plane configuration
557 * @disable_plane: shut down the plane
558 * @destroy: clean up plane resources
559 * @set_property: called when a property is changed
561 struct drm_plane_funcs {
562 int (*update_plane)(struct drm_plane *plane,
563 struct drm_crtc *crtc, struct drm_framebuffer *fb,
564 int crtc_x, int crtc_y,
565 unsigned int crtc_w, unsigned int crtc_h,
566 uint32_t src_x, uint32_t src_y,
567 uint32_t src_w, uint32_t src_h);
568 int (*disable_plane)(struct drm_plane *plane);
569 void (*destroy)(struct drm_plane *plane);
571 int (*set_property)(struct drm_plane *plane,
572 struct drm_property *property, uint64_t val);
575 enum drm_plane_type {
576 DRM_PLANE_TYPE_OVERLAY,
577 DRM_PLANE_TYPE_PRIMARY,
578 DRM_PLANE_TYPE_CURSOR,
582 * drm_plane - central DRM plane control structure
583 * @dev: DRM device this plane belongs to
584 * @head: for list management
585 * @base: base mode object
586 * @possible_crtcs: pipes this plane can be bound to
587 * @format_types: array of formats supported by this plane
588 * @format_count: number of formats supported
589 * @crtc: currently bound CRTC
590 * @fb: currently bound fb
591 * @funcs: helper functions
592 * @properties: property tracking for this plane
593 * @type: type of plane (overlay, primary, cursor)
596 struct drm_device *dev;
597 struct list_head head;
599 struct drm_mode_object base;
601 uint32_t possible_crtcs;
602 uint32_t *format_types;
603 uint32_t format_count;
605 struct drm_crtc *crtc;
606 struct drm_framebuffer *fb;
608 const struct drm_plane_funcs *funcs;
610 struct drm_object_properties properties;
612 enum drm_plane_type type;
616 * drm_bridge_funcs - drm_bridge control functions
617 * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
618 * @disable: Called right before encoder prepare, disables the bridge
619 * @post_disable: Called right after encoder prepare, for lockstepped disable
620 * @mode_set: Set this mode to the bridge
621 * @pre_enable: Called right before encoder commit, for lockstepped commit
622 * @enable: Called right after encoder commit, enables the bridge
623 * @destroy: make object go away
625 struct drm_bridge_funcs {
626 bool (*mode_fixup)(struct drm_bridge *bridge,
627 const struct drm_display_mode *mode,
628 struct drm_display_mode *adjusted_mode);
629 void (*disable)(struct drm_bridge *bridge);
630 void (*post_disable)(struct drm_bridge *bridge);
631 void (*mode_set)(struct drm_bridge *bridge,
632 struct drm_display_mode *mode,
633 struct drm_display_mode *adjusted_mode);
634 void (*pre_enable)(struct drm_bridge *bridge);
635 void (*enable)(struct drm_bridge *bridge);
636 void (*destroy)(struct drm_bridge *bridge);
640 * drm_bridge - central DRM bridge control structure
641 * @dev: DRM device this bridge belongs to
642 * @head: list management
643 * @base: base mode object
644 * @funcs: control functions
645 * @driver_private: pointer to the bridge driver's internal context
648 struct drm_device *dev;
649 struct list_head head;
651 struct drm_mode_object base;
653 const struct drm_bridge_funcs *funcs;
654 void *driver_private;
658 * drm_mode_set - new values for a CRTC config change
659 * @head: list management
660 * @fb: framebuffer to use for new config
661 * @crtc: CRTC whose configuration we're about to change
662 * @mode: mode timings to use
663 * @x: position of this CRTC relative to @fb
664 * @y: position of this CRTC relative to @fb
665 * @connectors: array of connectors to drive with this CRTC if possible
666 * @num_connectors: size of @connectors array
668 * Represents a single crtc the connectors that it drives with what mode
669 * and from which framebuffer it scans out from.
671 * This is used to set modes.
673 struct drm_mode_set {
674 struct drm_framebuffer *fb;
675 struct drm_crtc *crtc;
676 struct drm_display_mode *mode;
681 struct drm_connector **connectors;
682 size_t num_connectors;
686 * struct drm_mode_config_funcs - basic driver provided mode setting functions
687 * @fb_create: create a new framebuffer object
688 * @output_poll_changed: function to handle output configuration changes
690 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
693 struct drm_mode_config_funcs {
694 struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
695 struct drm_file *file_priv,
696 struct drm_mode_fb_cmd2 *mode_cmd);
697 void (*output_poll_changed)(struct drm_device *dev);
701 * drm_mode_group - group of mode setting resources for potential sub-grouping
702 * @num_crtcs: CRTC count
703 * @num_encoders: encoder count
704 * @num_connectors: connector count
705 * @id_list: list of KMS object IDs in this group
707 * Currently this simply tracks the global mode setting state. But in the
708 * future it could allow groups of objects to be set aside into independent
709 * control groups for use by different user level processes (e.g. two X servers
710 * running simultaneously on different heads, each with their own mode
711 * configuration and freedom of mode setting).
713 struct drm_mode_group {
715 uint32_t num_encoders;
716 uint32_t num_connectors;
717 uint32_t num_bridges;
719 /* list of object IDs for this group */
724 * drm_mode_config - Mode configuration control structure
725 * @mutex: mutex protecting KMS related lists and structures
726 * @idr_mutex: mutex for KMS ID allocation and management
727 * @crtc_idr: main KMS ID tracking object
728 * @num_fb: number of fbs available
729 * @fb_list: list of framebuffers available
730 * @num_connector: number of connectors on this device
731 * @connector_list: list of connector objects
732 * @num_bridge: number of bridges on this device
733 * @bridge_list: list of bridge objects
734 * @num_encoder: number of encoders on this device
735 * @encoder_list: list of encoder objects
736 * @num_crtc: number of CRTCs on this device
737 * @crtc_list: list of CRTC objects
738 * @min_width: minimum pixel width on this device
739 * @min_height: minimum pixel height on this device
740 * @max_width: maximum pixel width on this device
741 * @max_height: maximum pixel height on this device
742 * @funcs: core driver provided mode setting functions
743 * @fb_base: base address of the framebuffer
744 * @poll_enabled: track polling status for this device
745 * @output_poll_work: delayed work for polling in process context
746 * @*_property: core property tracking
748 * Core mode resource tracking structure. All CRTC, encoders, and connectors
749 * enumerated by the driver are added here, as are global properties. Some
750 * global restrictions are also here, e.g. dimension restrictions.
752 struct drm_mode_config {
753 struct mutex mutex; /* protects configuration (mode lists etc.) */
754 struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */
755 struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */
756 struct mutex idr_mutex; /* for IDR management */
757 struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
758 /* this is limited to one for now */
762 * fb_lock - mutex to protect fb state
764 * Besides the global fb list his also protects the fbs list in the
767 struct mutex fb_lock;
769 struct list_head fb_list;
772 struct list_head connector_list;
774 struct list_head bridge_list;
776 struct list_head encoder_list;
779 * Track # of overlay planes separately from # of total planes. By
780 * default we only advertise overlay planes to userspace; if userspace
781 * sets the "universal plane" capability bit, we'll go ahead and
784 int num_overlay_plane;
786 struct list_head plane_list;
789 struct list_head crtc_list;
791 struct list_head property_list;
793 int min_width, min_height;
794 int max_width, max_height;
795 const struct drm_mode_config_funcs *funcs;
796 resource_size_t fb_base;
798 /* output poll support */
801 struct delayed_work output_poll_work;
803 /* pointers to standard properties */
804 struct list_head property_blob_list;
805 struct drm_property *edid_property;
806 struct drm_property *dpms_property;
807 struct drm_property *plane_type_property;
809 /* DVI-I properties */
810 struct drm_property *dvi_i_subconnector_property;
811 struct drm_property *dvi_i_select_subconnector_property;
814 struct drm_property *tv_subconnector_property;
815 struct drm_property *tv_select_subconnector_property;
816 struct drm_property *tv_mode_property;
817 struct drm_property *tv_left_margin_property;
818 struct drm_property *tv_right_margin_property;
819 struct drm_property *tv_top_margin_property;
820 struct drm_property *tv_bottom_margin_property;
821 struct drm_property *tv_brightness_property;
822 struct drm_property *tv_contrast_property;
823 struct drm_property *tv_flicker_reduction_property;
824 struct drm_property *tv_overscan_property;
825 struct drm_property *tv_saturation_property;
826 struct drm_property *tv_hue_property;
828 /* Optional properties */
829 struct drm_property *scaling_mode_property;
830 struct drm_property *dirty_info_property;
832 /* dumb ioctl parameters */
833 uint32_t preferred_depth, prefer_shadow;
835 /* whether async page flip is supported or not */
836 bool async_page_flip;
839 uint32_t cursor_width, cursor_height;
842 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
843 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
844 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
845 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
846 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
847 #define obj_to_property(x) container_of(x, struct drm_property, base)
848 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
849 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
851 struct drm_prop_enum_list {
856 extern int drm_crtc_init_with_planes(struct drm_device *dev,
857 struct drm_crtc *crtc,
858 struct drm_plane *primary,
859 struct drm_plane *cursor,
860 const struct drm_crtc_funcs *funcs);
861 extern int drm_crtc_init(struct drm_device *dev,
862 struct drm_crtc *crtc,
863 const struct drm_crtc_funcs *funcs);
864 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
865 extern unsigned int drm_crtc_index(struct drm_crtc *crtc);
868 * drm_crtc_mask - find the mask of a registered CRTC
869 * @crtc: CRTC to find mask for
871 * Given a registered CRTC, return the mask bit of that CRTC for an
872 * encoder's possible_crtcs field.
874 static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
876 return 1 << drm_crtc_index(crtc);
879 extern void drm_connector_ida_init(void);
880 extern void drm_connector_ida_destroy(void);
881 extern int drm_connector_init(struct drm_device *dev,
882 struct drm_connector *connector,
883 const struct drm_connector_funcs *funcs,
886 extern void drm_connector_cleanup(struct drm_connector *connector);
887 /* helper to unplug all connectors from sysfs for device */
888 extern void drm_connector_unplug_all(struct drm_device *dev);
890 extern int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge,
891 const struct drm_bridge_funcs *funcs);
892 extern void drm_bridge_cleanup(struct drm_bridge *bridge);
894 extern int drm_encoder_init(struct drm_device *dev,
895 struct drm_encoder *encoder,
896 const struct drm_encoder_funcs *funcs,
900 * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
901 * @encoder: encoder to test
902 * @crtc: crtc to test
904 * Return false if @encoder can't be driven by @crtc, true otherwise.
906 static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
907 struct drm_crtc *crtc)
909 return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
912 extern int drm_universal_plane_init(struct drm_device *dev,
913 struct drm_plane *plane,
914 unsigned long possible_crtcs,
915 const struct drm_plane_funcs *funcs,
916 const uint32_t *formats,
917 uint32_t format_count,
918 enum drm_plane_type type);
919 extern int drm_plane_init(struct drm_device *dev,
920 struct drm_plane *plane,
921 unsigned long possible_crtcs,
922 const struct drm_plane_funcs *funcs,
923 const uint32_t *formats, uint32_t format_count,
925 extern void drm_plane_cleanup(struct drm_plane *plane);
926 extern void drm_plane_force_disable(struct drm_plane *plane);
927 extern int drm_crtc_check_viewport(const struct drm_crtc *crtc,
929 const struct drm_display_mode *mode,
930 const struct drm_framebuffer *fb);
932 extern void drm_encoder_cleanup(struct drm_encoder *encoder);
934 extern const char *drm_get_connector_status_name(enum drm_connector_status status);
935 extern const char *drm_get_subpixel_order_name(enum subpixel_order order);
936 extern const char *drm_get_dpms_name(int val);
937 extern const char *drm_get_dvi_i_subconnector_name(int val);
938 extern const char *drm_get_dvi_i_select_name(int val);
939 extern const char *drm_get_tv_subconnector_name(int val);
940 extern const char *drm_get_tv_select_name(int val);
941 extern void drm_fb_release(struct drm_file *file_priv);
942 extern int drm_mode_group_init_legacy_group(struct drm_device *dev, struct drm_mode_group *group);
943 extern void drm_mode_group_destroy(struct drm_mode_group *group);
944 extern bool drm_probe_ddc(struct i2c_adapter *adapter);
945 extern struct edid *drm_get_edid(struct drm_connector *connector,
946 struct i2c_adapter *adapter);
947 extern struct edid *drm_edid_duplicate(const struct edid *edid);
948 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
949 extern void drm_mode_config_init(struct drm_device *dev);
950 extern void drm_mode_config_reset(struct drm_device *dev);
951 extern void drm_mode_config_cleanup(struct drm_device *dev);
953 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
956 static inline bool drm_property_type_is(struct drm_property *property,
959 /* instanceof for props.. handles extended type vs original types: */
960 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
961 return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;
962 return property->flags & type;
965 static inline bool drm_property_type_valid(struct drm_property *property)
967 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
968 return !(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
969 return !!(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
972 extern int drm_object_property_set_value(struct drm_mode_object *obj,
973 struct drm_property *property,
975 extern int drm_object_property_get_value(struct drm_mode_object *obj,
976 struct drm_property *property,
978 extern int drm_framebuffer_init(struct drm_device *dev,
979 struct drm_framebuffer *fb,
980 const struct drm_framebuffer_funcs *funcs);
981 extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
983 extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
984 extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
985 extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
986 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
987 extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
989 extern void drm_object_attach_property(struct drm_mode_object *obj,
990 struct drm_property *property,
992 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
993 const char *name, int num_values);
994 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
996 const struct drm_prop_enum_list *props,
998 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
999 int flags, const char *name,
1000 const struct drm_prop_enum_list *props,
1002 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
1004 uint64_t min, uint64_t max);
1005 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
1006 int flags, const char *name,
1007 int64_t min, int64_t max);
1008 struct drm_property *drm_property_create_object(struct drm_device *dev,
1009 int flags, const char *name, uint32_t type);
1010 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
1011 extern int drm_property_add_enum(struct drm_property *property, int index,
1012 uint64_t value, const char *name);
1013 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1014 extern int drm_mode_create_tv_properties(struct drm_device *dev, int num_formats,
1016 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1017 extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
1019 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
1020 struct drm_encoder *encoder);
1021 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
1023 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
1024 uint32_t id, uint32_t type);
1027 extern int drm_mode_getresources(struct drm_device *dev,
1028 void *data, struct drm_file *file_priv);
1029 extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
1030 struct drm_file *file_priv);
1031 extern int drm_mode_getcrtc(struct drm_device *dev,
1032 void *data, struct drm_file *file_priv);
1033 extern int drm_mode_getconnector(struct drm_device *dev,
1034 void *data, struct drm_file *file_priv);
1035 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
1036 extern int drm_mode_setcrtc(struct drm_device *dev,
1037 void *data, struct drm_file *file_priv);
1038 extern int drm_mode_getplane(struct drm_device *dev,
1039 void *data, struct drm_file *file_priv);
1040 extern int drm_mode_setplane(struct drm_device *dev,
1041 void *data, struct drm_file *file_priv);
1042 extern int drm_mode_cursor_ioctl(struct drm_device *dev,
1043 void *data, struct drm_file *file_priv);
1044 extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
1045 void *data, struct drm_file *file_priv);
1046 extern int drm_mode_addfb(struct drm_device *dev,
1047 void *data, struct drm_file *file_priv);
1048 extern int drm_mode_addfb2(struct drm_device *dev,
1049 void *data, struct drm_file *file_priv);
1050 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
1051 extern int drm_mode_rmfb(struct drm_device *dev,
1052 void *data, struct drm_file *file_priv);
1053 extern int drm_mode_getfb(struct drm_device *dev,
1054 void *data, struct drm_file *file_priv);
1055 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1056 void *data, struct drm_file *file_priv);
1058 extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1059 void *data, struct drm_file *file_priv);
1060 extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1061 void *data, struct drm_file *file_priv);
1062 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1063 void *data, struct drm_file *file_priv);
1064 extern int drm_mode_getencoder(struct drm_device *dev,
1065 void *data, struct drm_file *file_priv);
1066 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1067 void *data, struct drm_file *file_priv);
1068 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1069 void *data, struct drm_file *file_priv);
1070 extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
1071 extern enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code);
1072 extern bool drm_detect_hdmi_monitor(struct edid *edid);
1073 extern bool drm_detect_monitor_audio(struct edid *edid);
1074 extern bool drm_rgb_quant_range_selectable(struct edid *edid);
1075 extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1076 void *data, struct drm_file *file_priv);
1077 extern int drm_add_modes_noedid(struct drm_connector *connector,
1078 int hdisplay, int vdisplay);
1079 extern void drm_set_preferred_mode(struct drm_connector *connector,
1080 int hpref, int vpref);
1082 extern int drm_edid_header_is_valid(const u8 *raw_edid);
1083 extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid);
1084 extern bool drm_edid_is_valid(struct edid *edid);
1085 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
1086 int hsize, int vsize, int fresh,
1089 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1090 void *data, struct drm_file *file_priv);
1091 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1092 void *data, struct drm_file *file_priv);
1093 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1094 void *data, struct drm_file *file_priv);
1095 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1096 struct drm_file *file_priv);
1097 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1098 struct drm_file *file_priv);
1100 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1102 extern int drm_format_num_planes(uint32_t format);
1103 extern int drm_format_plane_cpp(uint32_t format, int plane);
1104 extern int drm_format_horz_chroma_subsampling(uint32_t format);
1105 extern int drm_format_vert_chroma_subsampling(uint32_t format);
1106 extern const char *drm_get_format_name(uint32_t format);
1110 static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
1113 struct drm_mode_object *mo;
1114 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE);
1115 return mo ? obj_to_plane(mo) : NULL;
1118 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1121 struct drm_mode_object *mo;
1122 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1123 return mo ? obj_to_crtc(mo) : NULL;
1126 static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
1129 struct drm_mode_object *mo;
1130 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
1131 return mo ? obj_to_encoder(mo) : NULL;
1134 static inline struct drm_connector *drm_connector_find(struct drm_device *dev,
1137 struct drm_mode_object *mo;
1138 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR);
1139 return mo ? obj_to_connector(mo) : NULL;
1142 static inline struct drm_property *drm_property_find(struct drm_device *dev,
1145 struct drm_mode_object *mo;
1146 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY);
1147 return mo ? obj_to_property(mo) : NULL;
1150 static inline struct drm_property_blob *
1151 drm_property_blob_find(struct drm_device *dev, uint32_t id)
1153 struct drm_mode_object *mo;
1154 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_BLOB);
1155 return mo ? obj_to_blob(mo) : NULL;
1158 /* Plane list iterator for legacy (overlay only) planes. */
1159 #define drm_for_each_legacy_plane(plane, planelist) \
1160 list_for_each_entry(plane, planelist, head) \
1161 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1163 #endif /* __DRM_CRTC_H__ */