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 /* Temporary tracking of the old fb while a modeset is ongoing. Used
335 * by drm_mode_set_config_internal to implement correct refcounting. */
336 struct drm_framebuffer *old_fb;
340 /* Requested mode from modesetting. */
341 struct drm_display_mode mode;
343 /* Programmed mode in hw, after adjustments for encoders,
344 * crtc, panel scaling etc. Needed for timestamping etc.
346 struct drm_display_mode hwmode;
348 bool invert_dimensions;
351 const struct drm_crtc_funcs *funcs;
353 /* CRTC gamma size for reporting to userspace */
355 uint16_t *gamma_store;
357 /* Constants needed for precise vblank and swap timestamping. */
358 int framedur_ns, linedur_ns, pixeldur_ns;
360 /* if you are using the helper */
361 void *helper_private;
363 struct drm_object_properties properties;
368 * drm_connector_funcs - control connectors on a given device
369 * @dpms: set power state (see drm_crtc_funcs above)
370 * @save: save connector state
371 * @restore: restore connector state
372 * @reset: reset connector after state has been invalidated (e.g. resume)
373 * @detect: is this connector active?
374 * @fill_modes: fill mode list for this connector
375 * @set_property: property for this connector may need an update
376 * @destroy: make object go away
377 * @force: notify the driver that the connector is forced on
379 * Each CRTC may have one or more connectors attached to it. The functions
380 * below allow the core DRM code to control connectors, enumerate available modes,
383 struct drm_connector_funcs {
384 void (*dpms)(struct drm_connector *connector, int mode);
385 void (*save)(struct drm_connector *connector);
386 void (*restore)(struct drm_connector *connector);
387 void (*reset)(struct drm_connector *connector);
389 /* Check to see if anything is attached to the connector.
390 * @force is set to false whilst polling, true when checking the
391 * connector due to user request. @force can be used by the driver
392 * to avoid expensive, destructive operations during automated
395 enum drm_connector_status (*detect)(struct drm_connector *connector,
397 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
398 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
400 void (*destroy)(struct drm_connector *connector);
401 void (*force)(struct drm_connector *connector);
405 * drm_encoder_funcs - encoder controls
406 * @reset: reset state (e.g. at init or resume time)
407 * @destroy: cleanup and free associated data
409 * Encoders sit between CRTCs and connectors.
411 struct drm_encoder_funcs {
412 void (*reset)(struct drm_encoder *encoder);
413 void (*destroy)(struct drm_encoder *encoder);
416 #define DRM_CONNECTOR_MAX_ENCODER 3
419 * drm_encoder - central DRM encoder structure
420 * @dev: parent DRM device
421 * @head: list management
422 * @base: base KMS object
423 * @name: encoder name
424 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
425 * @possible_crtcs: bitmask of potential CRTC bindings
426 * @possible_clones: bitmask of potential sibling encoders for cloning
427 * @crtc: currently bound CRTC
428 * @bridge: bridge associated to the encoder
429 * @funcs: control functions
430 * @helper_private: mid-layer private data
432 * CRTCs drive pixels to encoders, which convert them into signals
433 * appropriate for a given connector or set of connectors.
436 struct drm_device *dev;
437 struct list_head head;
439 struct drm_mode_object base;
442 uint32_t possible_crtcs;
443 uint32_t possible_clones;
445 struct drm_crtc *crtc;
446 struct drm_bridge *bridge;
447 const struct drm_encoder_funcs *funcs;
448 void *helper_private;
451 /* should we poll this connector for connects and disconnects */
452 /* hot plug detectable */
453 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
454 /* poll for connections */
455 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
456 /* can cleanly poll for disconnections without flickering the screen */
457 /* DACs should rarely do this without a lot of testing */
458 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
460 #define MAX_ELD_BYTES 128
463 * drm_connector - central DRM connector control structure
464 * @dev: parent DRM device
465 * @kdev: kernel device for sysfs attributes
466 * @attr: sysfs attributes
467 * @head: list management
468 * @base: base KMS object
469 * @name: connector name
470 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
471 * @connector_type_id: index into connector type enum
472 * @interlace_allowed: can this connector handle interlaced modes?
473 * @doublescan_allowed: can this connector handle doublescan?
474 * @modes: modes available on this connector (from fill_modes() + user)
475 * @status: one of the drm_connector_status enums (connected, not, or unknown)
476 * @probed_modes: list of modes derived directly from the display
477 * @display_info: information about attached display (e.g. from EDID)
478 * @funcs: connector control functions
479 * @edid_blob_ptr: DRM property containing EDID if present
480 * @properties: property tracking for this connector
481 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
482 * @dpms: current dpms state
483 * @helper_private: mid-layer private data
484 * @force: a %DRM_FORCE_<foo> state for forced mode sets
485 * @encoder_ids: valid encoders for this connector
486 * @encoder: encoder driving this connector, if any
487 * @eld: EDID-like data, if present
488 * @dvi_dual: dual link DVI, if found
489 * @max_tmds_clock: max clock rate, if found
490 * @latency_present: AV delay info from ELD, if found
491 * @video_latency: video latency info from ELD, if found
492 * @audio_latency: audio latency info from ELD, if found
493 * @null_edid_counter: track sinks that give us all zeros for the EDID
495 * Each connector may be connected to one or more CRTCs, or may be clonable by
496 * another connector if they can share a CRTC. Each connector also has a specific
497 * position in the broader display (referred to as a 'screen' though it could
498 * span multiple monitors).
500 struct drm_connector {
501 struct drm_device *dev;
503 struct device_attribute *attr;
504 struct list_head head;
506 struct drm_mode_object base;
510 int connector_type_id;
511 bool interlace_allowed;
512 bool doublescan_allowed;
514 struct list_head modes; /* list of modes on this connector */
516 enum drm_connector_status status;
518 /* these are modes added by probing with DDC or the BIOS */
519 struct list_head probed_modes;
521 struct drm_display_info display_info;
522 const struct drm_connector_funcs *funcs;
524 struct drm_property_blob *edid_blob_ptr;
525 struct drm_object_properties properties;
527 uint8_t polled; /* DRM_CONNECTOR_POLL_* */
529 /* requested DPMS state */
532 void *helper_private;
534 /* forced on connector */
535 enum drm_connector_force force;
537 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
538 struct drm_encoder *encoder; /* currently active encoder */
541 uint8_t eld[MAX_ELD_BYTES];
543 int max_tmds_clock; /* in MHz */
544 bool latency_present[2];
545 int video_latency[2]; /* [0]: progressive, [1]: interlaced */
546 int audio_latency[2];
547 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
548 unsigned bad_edid_counter;
550 struct dentry *debugfs_entry;
554 * drm_plane_funcs - driver plane control functions
555 * @update_plane: update the plane configuration
556 * @disable_plane: shut down the plane
557 * @destroy: clean up plane resources
558 * @set_property: called when a property is changed
560 struct drm_plane_funcs {
561 int (*update_plane)(struct drm_plane *plane,
562 struct drm_crtc *crtc, struct drm_framebuffer *fb,
563 int crtc_x, int crtc_y,
564 unsigned int crtc_w, unsigned int crtc_h,
565 uint32_t src_x, uint32_t src_y,
566 uint32_t src_w, uint32_t src_h);
567 int (*disable_plane)(struct drm_plane *plane);
568 void (*destroy)(struct drm_plane *plane);
570 int (*set_property)(struct drm_plane *plane,
571 struct drm_property *property, uint64_t val);
574 enum drm_plane_type {
575 DRM_PLANE_TYPE_OVERLAY,
576 DRM_PLANE_TYPE_PRIMARY,
577 DRM_PLANE_TYPE_CURSOR,
581 * drm_plane - central DRM plane control structure
582 * @dev: DRM device this plane belongs to
583 * @head: for list management
584 * @base: base mode object
585 * @possible_crtcs: pipes this plane can be bound to
586 * @format_types: array of formats supported by this plane
587 * @format_count: number of formats supported
588 * @crtc: currently bound CRTC
589 * @fb: currently bound fb
590 * @funcs: helper functions
591 * @properties: property tracking for this plane
592 * @type: type of plane (overlay, primary, cursor)
595 struct drm_device *dev;
596 struct list_head head;
598 struct drm_mode_object base;
600 uint32_t possible_crtcs;
601 uint32_t *format_types;
602 uint32_t format_count;
604 struct drm_crtc *crtc;
605 struct drm_framebuffer *fb;
607 const struct drm_plane_funcs *funcs;
609 struct drm_object_properties properties;
611 enum drm_plane_type type;
615 * drm_bridge_funcs - drm_bridge control functions
616 * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
617 * @disable: Called right before encoder prepare, disables the bridge
618 * @post_disable: Called right after encoder prepare, for lockstepped disable
619 * @mode_set: Set this mode to the bridge
620 * @pre_enable: Called right before encoder commit, for lockstepped commit
621 * @enable: Called right after encoder commit, enables the bridge
622 * @destroy: make object go away
624 struct drm_bridge_funcs {
625 bool (*mode_fixup)(struct drm_bridge *bridge,
626 const struct drm_display_mode *mode,
627 struct drm_display_mode *adjusted_mode);
628 void (*disable)(struct drm_bridge *bridge);
629 void (*post_disable)(struct drm_bridge *bridge);
630 void (*mode_set)(struct drm_bridge *bridge,
631 struct drm_display_mode *mode,
632 struct drm_display_mode *adjusted_mode);
633 void (*pre_enable)(struct drm_bridge *bridge);
634 void (*enable)(struct drm_bridge *bridge);
635 void (*destroy)(struct drm_bridge *bridge);
639 * drm_bridge - central DRM bridge control structure
640 * @dev: DRM device this bridge belongs to
641 * @head: list management
642 * @base: base mode object
643 * @funcs: control functions
644 * @driver_private: pointer to the bridge driver's internal context
647 struct drm_device *dev;
648 struct list_head head;
650 struct drm_mode_object base;
652 const struct drm_bridge_funcs *funcs;
653 void *driver_private;
657 * drm_mode_set - new values for a CRTC config change
658 * @head: list management
659 * @fb: framebuffer to use for new config
660 * @crtc: CRTC whose configuration we're about to change
661 * @mode: mode timings to use
662 * @x: position of this CRTC relative to @fb
663 * @y: position of this CRTC relative to @fb
664 * @connectors: array of connectors to drive with this CRTC if possible
665 * @num_connectors: size of @connectors array
667 * Represents a single crtc the connectors that it drives with what mode
668 * and from which framebuffer it scans out from.
670 * This is used to set modes.
672 struct drm_mode_set {
673 struct drm_framebuffer *fb;
674 struct drm_crtc *crtc;
675 struct drm_display_mode *mode;
680 struct drm_connector **connectors;
681 size_t num_connectors;
685 * struct drm_mode_config_funcs - basic driver provided mode setting functions
686 * @fb_create: create a new framebuffer object
687 * @output_poll_changed: function to handle output configuration changes
689 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
692 struct drm_mode_config_funcs {
693 struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
694 struct drm_file *file_priv,
695 struct drm_mode_fb_cmd2 *mode_cmd);
696 void (*output_poll_changed)(struct drm_device *dev);
700 * drm_mode_group - group of mode setting resources for potential sub-grouping
701 * @num_crtcs: CRTC count
702 * @num_encoders: encoder count
703 * @num_connectors: connector count
704 * @id_list: list of KMS object IDs in this group
706 * Currently this simply tracks the global mode setting state. But in the
707 * future it could allow groups of objects to be set aside into independent
708 * control groups for use by different user level processes (e.g. two X servers
709 * running simultaneously on different heads, each with their own mode
710 * configuration and freedom of mode setting).
712 struct drm_mode_group {
714 uint32_t num_encoders;
715 uint32_t num_connectors;
716 uint32_t num_bridges;
718 /* list of object IDs for this group */
723 * drm_mode_config - Mode configuration control structure
724 * @mutex: mutex protecting KMS related lists and structures
725 * @idr_mutex: mutex for KMS ID allocation and management
726 * @crtc_idr: main KMS ID tracking object
727 * @num_fb: number of fbs available
728 * @fb_list: list of framebuffers available
729 * @num_connector: number of connectors on this device
730 * @connector_list: list of connector objects
731 * @num_bridge: number of bridges on this device
732 * @bridge_list: list of bridge objects
733 * @num_encoder: number of encoders on this device
734 * @encoder_list: list of encoder objects
735 * @num_crtc: number of CRTCs on this device
736 * @crtc_list: list of CRTC objects
737 * @min_width: minimum pixel width on this device
738 * @min_height: minimum pixel height on this device
739 * @max_width: maximum pixel width on this device
740 * @max_height: maximum pixel height on this device
741 * @funcs: core driver provided mode setting functions
742 * @fb_base: base address of the framebuffer
743 * @poll_enabled: track polling status for this device
744 * @output_poll_work: delayed work for polling in process context
745 * @*_property: core property tracking
747 * Core mode resource tracking structure. All CRTC, encoders, and connectors
748 * enumerated by the driver are added here, as are global properties. Some
749 * global restrictions are also here, e.g. dimension restrictions.
751 struct drm_mode_config {
752 struct mutex mutex; /* protects configuration (mode lists etc.) */
753 struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */
754 struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */
755 struct mutex idr_mutex; /* for IDR management */
756 struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
757 /* this is limited to one for now */
761 * fb_lock - mutex to protect fb state
763 * Besides the global fb list his also protects the fbs list in the
766 struct mutex fb_lock;
768 struct list_head fb_list;
771 struct list_head connector_list;
773 struct list_head bridge_list;
775 struct list_head encoder_list;
778 * Track # of overlay planes separately from # of total planes. By
779 * default we only advertise overlay planes to userspace; if userspace
780 * sets the "universal plane" capability bit, we'll go ahead and
783 int num_overlay_plane;
785 struct list_head plane_list;
788 struct list_head crtc_list;
790 struct list_head property_list;
792 int min_width, min_height;
793 int max_width, max_height;
794 const struct drm_mode_config_funcs *funcs;
795 resource_size_t fb_base;
797 /* output poll support */
800 struct delayed_work output_poll_work;
802 /* pointers to standard properties */
803 struct list_head property_blob_list;
804 struct drm_property *edid_property;
805 struct drm_property *dpms_property;
806 struct drm_property *plane_type_property;
808 /* DVI-I properties */
809 struct drm_property *dvi_i_subconnector_property;
810 struct drm_property *dvi_i_select_subconnector_property;
813 struct drm_property *tv_subconnector_property;
814 struct drm_property *tv_select_subconnector_property;
815 struct drm_property *tv_mode_property;
816 struct drm_property *tv_left_margin_property;
817 struct drm_property *tv_right_margin_property;
818 struct drm_property *tv_top_margin_property;
819 struct drm_property *tv_bottom_margin_property;
820 struct drm_property *tv_brightness_property;
821 struct drm_property *tv_contrast_property;
822 struct drm_property *tv_flicker_reduction_property;
823 struct drm_property *tv_overscan_property;
824 struct drm_property *tv_saturation_property;
825 struct drm_property *tv_hue_property;
827 /* Optional properties */
828 struct drm_property *scaling_mode_property;
829 struct drm_property *dirty_info_property;
831 /* dumb ioctl parameters */
832 uint32_t preferred_depth, prefer_shadow;
834 /* whether async page flip is supported or not */
835 bool async_page_flip;
838 uint32_t cursor_width, cursor_height;
841 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
842 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
843 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
844 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
845 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
846 #define obj_to_property(x) container_of(x, struct drm_property, base)
847 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
848 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
850 struct drm_prop_enum_list {
855 extern int drm_crtc_init_with_planes(struct drm_device *dev,
856 struct drm_crtc *crtc,
857 struct drm_plane *primary,
859 const struct drm_crtc_funcs *funcs);
860 extern int drm_crtc_init(struct drm_device *dev,
861 struct drm_crtc *crtc,
862 const struct drm_crtc_funcs *funcs);
863 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
864 extern unsigned int drm_crtc_index(struct drm_crtc *crtc);
867 * drm_crtc_mask - find the mask of a registered CRTC
868 * @crtc: CRTC to find mask for
870 * Given a registered CRTC, return the mask bit of that CRTC for an
871 * encoder's possible_crtcs field.
873 static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
875 return 1 << drm_crtc_index(crtc);
878 extern void drm_connector_ida_init(void);
879 extern void drm_connector_ida_destroy(void);
880 extern int drm_connector_init(struct drm_device *dev,
881 struct drm_connector *connector,
882 const struct drm_connector_funcs *funcs,
884 int drm_connector_register(struct drm_connector *connector);
885 void drm_connector_unregister(struct drm_connector *connector);
887 extern void drm_connector_cleanup(struct drm_connector *connector);
888 /* helper to unplug all connectors from sysfs for device */
889 extern void drm_connector_unplug_all(struct drm_device *dev);
891 extern int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge,
892 const struct drm_bridge_funcs *funcs);
893 extern void drm_bridge_cleanup(struct drm_bridge *bridge);
895 extern int drm_encoder_init(struct drm_device *dev,
896 struct drm_encoder *encoder,
897 const struct drm_encoder_funcs *funcs,
901 * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
902 * @encoder: encoder to test
903 * @crtc: crtc to test
905 * Return false if @encoder can't be driven by @crtc, true otherwise.
907 static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
908 struct drm_crtc *crtc)
910 return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
913 extern int drm_universal_plane_init(struct drm_device *dev,
914 struct drm_plane *plane,
915 unsigned long possible_crtcs,
916 const struct drm_plane_funcs *funcs,
917 const uint32_t *formats,
918 uint32_t format_count,
919 enum drm_plane_type type);
920 extern int drm_plane_init(struct drm_device *dev,
921 struct drm_plane *plane,
922 unsigned long possible_crtcs,
923 const struct drm_plane_funcs *funcs,
924 const uint32_t *formats, uint32_t format_count,
926 extern void drm_plane_cleanup(struct drm_plane *plane);
927 extern void drm_plane_force_disable(struct drm_plane *plane);
928 extern int drm_crtc_check_viewport(const struct drm_crtc *crtc,
930 const struct drm_display_mode *mode,
931 const struct drm_framebuffer *fb);
933 extern void drm_encoder_cleanup(struct drm_encoder *encoder);
935 extern const char *drm_get_connector_status_name(enum drm_connector_status status);
936 extern const char *drm_get_subpixel_order_name(enum subpixel_order order);
937 extern const char *drm_get_dpms_name(int val);
938 extern const char *drm_get_dvi_i_subconnector_name(int val);
939 extern const char *drm_get_dvi_i_select_name(int val);
940 extern const char *drm_get_tv_subconnector_name(int val);
941 extern const char *drm_get_tv_select_name(int val);
942 extern void drm_fb_release(struct drm_file *file_priv);
943 extern int drm_mode_group_init_legacy_group(struct drm_device *dev, struct drm_mode_group *group);
944 extern void drm_mode_group_destroy(struct drm_mode_group *group);
945 extern bool drm_probe_ddc(struct i2c_adapter *adapter);
946 extern struct edid *drm_get_edid(struct drm_connector *connector,
947 struct i2c_adapter *adapter);
948 extern struct edid *drm_edid_duplicate(const struct edid *edid);
949 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
950 extern void drm_mode_config_init(struct drm_device *dev);
951 extern void drm_mode_config_reset(struct drm_device *dev);
952 extern void drm_mode_config_cleanup(struct drm_device *dev);
954 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
957 static inline bool drm_property_type_is(struct drm_property *property,
960 /* instanceof for props.. handles extended type vs original types: */
961 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
962 return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;
963 return property->flags & type;
966 static inline bool drm_property_type_valid(struct drm_property *property)
968 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
969 return !(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
970 return !!(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
973 extern int drm_object_property_set_value(struct drm_mode_object *obj,
974 struct drm_property *property,
976 extern int drm_object_property_get_value(struct drm_mode_object *obj,
977 struct drm_property *property,
979 extern int drm_framebuffer_init(struct drm_device *dev,
980 struct drm_framebuffer *fb,
981 const struct drm_framebuffer_funcs *funcs);
982 extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
984 extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
985 extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
986 extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
987 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
988 extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
990 extern void drm_object_attach_property(struct drm_mode_object *obj,
991 struct drm_property *property,
993 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
994 const char *name, int num_values);
995 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
997 const struct drm_prop_enum_list *props,
999 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
1000 int flags, const char *name,
1001 const struct drm_prop_enum_list *props,
1003 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
1005 uint64_t min, uint64_t max);
1006 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
1007 int flags, const char *name,
1008 int64_t min, int64_t max);
1009 struct drm_property *drm_property_create_object(struct drm_device *dev,
1010 int flags, const char *name, uint32_t type);
1011 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
1012 extern int drm_property_add_enum(struct drm_property *property, int index,
1013 uint64_t value, const char *name);
1014 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1015 extern int drm_mode_create_tv_properties(struct drm_device *dev, int num_formats,
1017 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1018 extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
1020 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
1021 struct drm_encoder *encoder);
1022 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
1024 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
1025 uint32_t id, uint32_t type);
1028 extern int drm_mode_getresources(struct drm_device *dev,
1029 void *data, struct drm_file *file_priv);
1030 extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
1031 struct drm_file *file_priv);
1032 extern int drm_mode_getcrtc(struct drm_device *dev,
1033 void *data, struct drm_file *file_priv);
1034 extern int drm_mode_getconnector(struct drm_device *dev,
1035 void *data, struct drm_file *file_priv);
1036 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
1037 extern int drm_mode_setcrtc(struct drm_device *dev,
1038 void *data, struct drm_file *file_priv);
1039 extern int drm_mode_getplane(struct drm_device *dev,
1040 void *data, struct drm_file *file_priv);
1041 extern int drm_mode_setplane(struct drm_device *dev,
1042 void *data, struct drm_file *file_priv);
1043 extern int drm_mode_cursor_ioctl(struct drm_device *dev,
1044 void *data, struct drm_file *file_priv);
1045 extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
1046 void *data, struct drm_file *file_priv);
1047 extern int drm_mode_addfb(struct drm_device *dev,
1048 void *data, struct drm_file *file_priv);
1049 extern int drm_mode_addfb2(struct drm_device *dev,
1050 void *data, struct drm_file *file_priv);
1051 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
1052 extern int drm_mode_rmfb(struct drm_device *dev,
1053 void *data, struct drm_file *file_priv);
1054 extern int drm_mode_getfb(struct drm_device *dev,
1055 void *data, struct drm_file *file_priv);
1056 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1057 void *data, struct drm_file *file_priv);
1059 extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1060 void *data, struct drm_file *file_priv);
1061 extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1062 void *data, struct drm_file *file_priv);
1063 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1064 void *data, struct drm_file *file_priv);
1065 extern int drm_mode_getencoder(struct drm_device *dev,
1066 void *data, struct drm_file *file_priv);
1067 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1068 void *data, struct drm_file *file_priv);
1069 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1070 void *data, struct drm_file *file_priv);
1071 extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
1072 extern enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code);
1073 extern bool drm_detect_hdmi_monitor(struct edid *edid);
1074 extern bool drm_detect_monitor_audio(struct edid *edid);
1075 extern bool drm_rgb_quant_range_selectable(struct edid *edid);
1076 extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1077 void *data, struct drm_file *file_priv);
1078 extern int drm_add_modes_noedid(struct drm_connector *connector,
1079 int hdisplay, int vdisplay);
1080 extern void drm_set_preferred_mode(struct drm_connector *connector,
1081 int hpref, int vpref);
1083 extern int drm_edid_header_is_valid(const u8 *raw_edid);
1084 extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid);
1085 extern bool drm_edid_is_valid(struct edid *edid);
1086 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
1087 int hsize, int vsize, int fresh,
1090 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1091 void *data, struct drm_file *file_priv);
1092 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1093 void *data, struct drm_file *file_priv);
1094 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1095 void *data, struct drm_file *file_priv);
1096 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1097 struct drm_file *file_priv);
1098 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1099 struct drm_file *file_priv);
1101 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1103 extern int drm_format_num_planes(uint32_t format);
1104 extern int drm_format_plane_cpp(uint32_t format, int plane);
1105 extern int drm_format_horz_chroma_subsampling(uint32_t format);
1106 extern int drm_format_vert_chroma_subsampling(uint32_t format);
1107 extern const char *drm_get_format_name(uint32_t format);
1111 static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
1114 struct drm_mode_object *mo;
1115 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE);
1116 return mo ? obj_to_plane(mo) : NULL;
1119 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1122 struct drm_mode_object *mo;
1123 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1124 return mo ? obj_to_crtc(mo) : NULL;
1127 static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
1130 struct drm_mode_object *mo;
1131 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
1132 return mo ? obj_to_encoder(mo) : NULL;
1135 static inline struct drm_connector *drm_connector_find(struct drm_device *dev,
1138 struct drm_mode_object *mo;
1139 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR);
1140 return mo ? obj_to_connector(mo) : NULL;
1143 static inline struct drm_property *drm_property_find(struct drm_device *dev,
1146 struct drm_mode_object *mo;
1147 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY);
1148 return mo ? obj_to_property(mo) : NULL;
1151 static inline struct drm_property_blob *
1152 drm_property_blob_find(struct drm_device *dev, uint32_t id)
1154 struct drm_mode_object *mo;
1155 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_BLOB);
1156 return mo ? obj_to_blob(mo) : NULL;
1159 /* Plane list iterator for legacy (overlay only) planes. */
1160 #define drm_for_each_legacy_plane(plane, planelist) \
1161 list_for_each_entry(plane, planelist, head) \
1162 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1164 #endif /* __DRM_CRTC_H__ */