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 <drm/drm_mode.h>
35 #include <drm/drm_fourcc.h>
39 struct drm_framebuffer;
40 struct drm_object_properties;
44 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
45 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
46 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
47 #define DRM_MODE_OBJECT_MODE 0xdededede
48 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
49 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
50 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
51 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
53 struct drm_mode_object {
56 struct drm_object_properties *properties;
59 #define DRM_OBJECT_MAX_PROPERTY 24
60 struct drm_object_properties {
62 uint32_t ids[DRM_OBJECT_MAX_PROPERTY];
63 uint64_t values[DRM_OBJECT_MAX_PROPERTY];
67 * Note on terminology: here, for brevity and convenience, we refer to connector
68 * control chips as 'CRTCs'. They can control any type of connector, VGA, LVDS,
69 * DVI, etc. And 'screen' refers to the whole of the visible display, which
70 * may span multiple monitors (and therefore multiple CRTC and connector
74 enum drm_mode_status {
75 MODE_OK = 0, /* Mode OK */
76 MODE_HSYNC, /* hsync out of range */
77 MODE_VSYNC, /* vsync out of range */
78 MODE_H_ILLEGAL, /* mode has illegal horizontal timings */
79 MODE_V_ILLEGAL, /* mode has illegal horizontal timings */
80 MODE_BAD_WIDTH, /* requires an unsupported linepitch */
81 MODE_NOMODE, /* no mode with a matching name */
82 MODE_NO_INTERLACE, /* interlaced mode not supported */
83 MODE_NO_DBLESCAN, /* doublescan mode not supported */
84 MODE_NO_VSCAN, /* multiscan mode not supported */
85 MODE_MEM, /* insufficient video memory */
86 MODE_VIRTUAL_X, /* mode width too large for specified virtual size */
87 MODE_VIRTUAL_Y, /* mode height too large for specified virtual size */
88 MODE_MEM_VIRT, /* insufficient video memory given virtual size */
89 MODE_NOCLOCK, /* no fixed clock available */
90 MODE_CLOCK_HIGH, /* clock required is too high */
91 MODE_CLOCK_LOW, /* clock required is too low */
92 MODE_CLOCK_RANGE, /* clock/mode isn't in a ClockRange */
93 MODE_BAD_HVALUE, /* horizontal timing was out of range */
94 MODE_BAD_VVALUE, /* vertical timing was out of range */
95 MODE_BAD_VSCAN, /* VScan value out of range */
96 MODE_HSYNC_NARROW, /* horizontal sync too narrow */
97 MODE_HSYNC_WIDE, /* horizontal sync too wide */
98 MODE_HBLANK_NARROW, /* horizontal blanking too narrow */
99 MODE_HBLANK_WIDE, /* horizontal blanking too wide */
100 MODE_VSYNC_NARROW, /* vertical sync too narrow */
101 MODE_VSYNC_WIDE, /* vertical sync too wide */
102 MODE_VBLANK_NARROW, /* vertical blanking too narrow */
103 MODE_VBLANK_WIDE, /* vertical blanking too wide */
104 MODE_PANEL, /* exceeds panel dimensions */
105 MODE_INTERLACE_WIDTH, /* width too large for interlaced mode */
106 MODE_ONE_WIDTH, /* only one width is supported */
107 MODE_ONE_HEIGHT, /* only one height is supported */
108 MODE_ONE_SIZE, /* only one resolution is supported */
109 MODE_NO_REDUCED, /* monitor doesn't accept reduced blanking */
110 MODE_UNVERIFIED = -3, /* mode needs to reverified */
111 MODE_BAD = -2, /* unspecified reason */
112 MODE_ERROR = -1 /* error condition */
115 #define DRM_MODE_TYPE_CLOCK_CRTC_C (DRM_MODE_TYPE_CLOCK_C | \
116 DRM_MODE_TYPE_CRTC_C)
118 #define DRM_MODE(nm, t, c, hd, hss, hse, ht, hsk, vd, vss, vse, vt, vs, f) \
119 .name = nm, .status = 0, .type = (t), .clock = (c), \
120 .hdisplay = (hd), .hsync_start = (hss), .hsync_end = (hse), \
121 .htotal = (ht), .hskew = (hsk), .vdisplay = (vd), \
122 .vsync_start = (vss), .vsync_end = (vse), .vtotal = (vt), \
123 .vscan = (vs), .flags = (f), \
124 .base.type = DRM_MODE_OBJECT_MODE
126 #define CRTC_INTERLACE_HALVE_V 0x1 /* halve V values for interlacing */
128 struct drm_display_mode {
130 struct list_head head;
131 struct drm_mode_object base;
133 char name[DRM_DISPLAY_MODE_LEN];
135 enum drm_mode_status status;
138 /* Proposed mode values */
139 int clock; /* in kHz */
152 /* Addressable image size (may be 0 for projectors, etc.) */
156 /* Actual mode we give to hw */
160 int crtc_hblank_start;
162 int crtc_hsync_start;
167 int crtc_vblank_start;
169 int crtc_vsync_start;
173 /* Driver private mode info */
178 int vrefresh; /* in Hz */
179 int hsync; /* in kHz */
182 enum drm_connector_status {
183 connector_status_connected = 1,
184 connector_status_disconnected = 2,
185 connector_status_unknown = 3,
188 enum subpixel_order {
190 SubPixelHorizontalRGB,
191 SubPixelHorizontalBGR,
197 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
198 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
199 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
201 * Describes a given display (e.g. CRT or flat panel) and its limitations.
203 struct drm_display_info {
204 char name[DRM_DISPLAY_INFO_LEN];
207 unsigned int width_mm;
208 unsigned int height_mm;
210 /* Clock limits FIXME: storage format */
211 unsigned int min_vfreq, max_vfreq;
212 unsigned int min_hfreq, max_hfreq;
213 unsigned int pixel_clock;
216 enum subpixel_order subpixel_order;
222 struct drm_framebuffer_funcs {
223 /* note: use drm_framebuffer_remove() */
224 void (*destroy)(struct drm_framebuffer *framebuffer);
225 int (*create_handle)(struct drm_framebuffer *fb,
226 struct drm_file *file_priv,
227 unsigned int *handle);
229 * Optinal callback for the dirty fb ioctl.
231 * Userspace can notify the driver via this callback
232 * that a area of the framebuffer has changed and should
233 * be flushed to the display hardware.
235 * See documentation in drm_mode.h for the struct
236 * drm_mode_fb_dirty_cmd for more information as all
237 * the semantics and arguments have a one to one mapping
240 int (*dirty)(struct drm_framebuffer *framebuffer,
241 struct drm_file *file_priv, unsigned flags,
242 unsigned color, struct drm_clip_rect *clips,
246 struct drm_framebuffer {
247 struct drm_device *dev;
249 * Note that the fb is refcounted for the benefit of driver internals,
250 * for example some hw, disabling a CRTC/plane is asynchronous, and
251 * scanout does not actually complete until the next vblank. So some
252 * cleanup (like releasing the reference(s) on the backing GEM bo(s))
253 * should be deferred. In cases like this, the driver would like to
254 * hold a ref to the fb even though it has already been removed from
255 * userspace perspective.
257 struct kref refcount;
259 * Place on the dev->mode_config.fb_list, access protected by
260 * dev->mode_config.fb_lock.
262 struct list_head head;
263 struct drm_mode_object base;
264 const struct drm_framebuffer_funcs *funcs;
265 unsigned int pitches[4];
266 unsigned int offsets[4];
269 /* depth can be 15 or 16 */
273 uint32_t pixel_format; /* fourcc format */
274 struct list_head filp_head;
275 /* if you are using the helper */
276 void *helper_private;
279 struct drm_property_blob {
280 struct drm_mode_object base;
281 struct list_head head;
283 unsigned char data[];
286 struct drm_property_enum {
288 struct list_head head;
289 char name[DRM_PROP_NAME_LEN];
292 struct drm_property {
293 struct list_head head;
294 struct drm_mode_object base;
296 char name[DRM_PROP_NAME_LEN];
300 struct list_head enum_blob_list;
304 struct drm_connector;
306 struct drm_pending_vblank_event;
310 * drm_crtc_funcs - control CRTCs for a given device
311 * @save: save CRTC state
312 * @restore: restore CRTC state
313 * @reset: reset CRTC after state has been invalidated (e.g. resume)
314 * @cursor_set: setup the cursor
315 * @cursor_move: move the cursor
316 * @gamma_set: specify color ramp for CRTC
317 * @destroy: deinit and free object
318 * @set_property: called when a property is changed
319 * @set_config: apply a new CRTC configuration
320 * @page_flip: initiate a page flip
322 * The drm_crtc_funcs structure is the central CRTC management structure
323 * in the DRM. Each CRTC controls one or more connectors (note that the name
324 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
325 * connectors, not just CRTs).
327 * Each driver is responsible for filling out this structure at startup time,
328 * in addition to providing other modesetting features, like i2c and DDC
331 struct drm_crtc_funcs {
332 /* Save CRTC state */
333 void (*save)(struct drm_crtc *crtc); /* suspend? */
334 /* Restore CRTC state */
335 void (*restore)(struct drm_crtc *crtc); /* resume? */
336 /* Reset CRTC state */
337 void (*reset)(struct drm_crtc *crtc);
339 /* cursor controls */
340 int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
341 uint32_t handle, uint32_t width, uint32_t height);
342 int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
343 uint32_t handle, uint32_t width, uint32_t height,
344 int32_t hot_x, int32_t hot_y);
345 int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
347 /* Set gamma on the CRTC */
348 void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
349 uint32_t start, uint32_t size);
350 /* Object destroy routine */
351 void (*destroy)(struct drm_crtc *crtc);
353 int (*set_config)(struct drm_mode_set *set);
356 * Flip to the given framebuffer. This implements the page
357 * flip ioctl described in drm_mode.h, specifically, the
358 * implementation must return immediately and block all
359 * rendering to the current fb until the flip has completed.
360 * If userspace set the event flag in the ioctl, the event
361 * argument will point to an event to send back when the flip
362 * completes, otherwise it will be NULL.
364 int (*page_flip)(struct drm_crtc *crtc,
365 struct drm_framebuffer *fb,
366 struct drm_pending_vblank_event *event);
368 int (*set_property)(struct drm_crtc *crtc,
369 struct drm_property *property, uint64_t val);
373 * drm_crtc - central CRTC control structure
374 * @dev: parent DRM device
375 * @head: list management
376 * @base: base KMS object for ID tracking etc.
377 * @enabled: is this CRTC enabled?
378 * @mode: current mode timings
379 * @hwmode: mode timings as programmed to hw regs
380 * @invert_dimensions: for purposes of error checking crtc vs fb sizes,
381 * invert the width/height of the crtc. This is used if the driver
382 * is performing 90 or 270 degree rotated scanout
383 * @x: x position on screen
384 * @y: y position on screen
385 * @funcs: CRTC control functions
386 * @gamma_size: size of gamma ramp
387 * @gamma_store: gamma ramp values
388 * @framedur_ns: precise frame timing
389 * @framedur_ns: precise line timing
390 * @pixeldur_ns: precise pixel timing
391 * @helper_private: mid-layer private data
392 * @properties: property tracking for this CRTC
394 * Each CRTC may have one or more connectors associated with it. This structure
395 * allows the CRTC to be controlled.
398 struct drm_device *dev;
399 struct list_head head;
404 * This provides a read lock for the overall crtc state (mode, dpms
405 * state, ...) and a write lock for everything which can be update
406 * without a full modeset (fb, cursor data, ...)
410 struct drm_mode_object base;
412 /* framebuffer the connector is currently bound to */
413 struct drm_framebuffer *fb;
415 /* Temporary tracking of the old fb while a modeset is ongoing. Used
416 * by drm_mode_set_config_internal to implement correct refcounting. */
417 struct drm_framebuffer *old_fb;
421 /* Requested mode from modesetting. */
422 struct drm_display_mode mode;
424 /* Programmed mode in hw, after adjustments for encoders,
425 * crtc, panel scaling etc. Needed for timestamping etc.
427 struct drm_display_mode hwmode;
429 bool invert_dimensions;
432 const struct drm_crtc_funcs *funcs;
434 /* CRTC gamma size for reporting to userspace */
436 uint16_t *gamma_store;
438 /* Constants needed for precise vblank and swap timestamping. */
439 s64 framedur_ns, linedur_ns, pixeldur_ns;
441 /* if you are using the helper */
442 void *helper_private;
444 struct drm_object_properties properties;
449 * drm_connector_funcs - control connectors on a given device
450 * @dpms: set power state (see drm_crtc_funcs above)
451 * @save: save connector state
452 * @restore: restore connector state
453 * @reset: reset connector after state has been invalidated (e.g. resume)
454 * @detect: is this connector active?
455 * @fill_modes: fill mode list for this connector
456 * @set_property: property for this connector may need an update
457 * @destroy: make object go away
458 * @force: notify the driver that the connector is forced on
460 * Each CRTC may have one or more connectors attached to it. The functions
461 * below allow the core DRM code to control connectors, enumerate available modes,
464 struct drm_connector_funcs {
465 void (*dpms)(struct drm_connector *connector, int mode);
466 void (*save)(struct drm_connector *connector);
467 void (*restore)(struct drm_connector *connector);
468 void (*reset)(struct drm_connector *connector);
470 /* Check to see if anything is attached to the connector.
471 * @force is set to false whilst polling, true when checking the
472 * connector due to user request. @force can be used by the driver
473 * to avoid expensive, destructive operations during automated
476 enum drm_connector_status (*detect)(struct drm_connector *connector,
478 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
479 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
481 void (*destroy)(struct drm_connector *connector);
482 void (*force)(struct drm_connector *connector);
486 * drm_encoder_funcs - encoder controls
487 * @reset: reset state (e.g. at init or resume time)
488 * @destroy: cleanup and free associated data
490 * Encoders sit between CRTCs and connectors.
492 struct drm_encoder_funcs {
493 void (*reset)(struct drm_encoder *encoder);
494 void (*destroy)(struct drm_encoder *encoder);
497 #define DRM_CONNECTOR_MAX_ENCODER 3
500 * drm_encoder - central DRM encoder structure
501 * @dev: parent DRM device
502 * @head: list management
503 * @base: base KMS object
504 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
505 * @possible_crtcs: bitmask of potential CRTC bindings
506 * @possible_clones: bitmask of potential sibling encoders for cloning
507 * @crtc: currently bound CRTC
508 * @funcs: control functions
509 * @helper_private: mid-layer private data
511 * CRTCs drive pixels to encoders, which convert them into signals
512 * appropriate for a given connector or set of connectors.
515 struct drm_device *dev;
516 struct list_head head;
518 struct drm_mode_object base;
520 uint32_t possible_crtcs;
521 uint32_t possible_clones;
523 struct drm_crtc *crtc;
524 const struct drm_encoder_funcs *funcs;
525 void *helper_private;
528 enum drm_connector_force {
529 DRM_FORCE_UNSPECIFIED,
531 DRM_FORCE_ON, /* force on analog part normally */
532 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
535 /* should we poll this connector for connects and disconnects */
536 /* hot plug detectable */
537 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
538 /* poll for connections */
539 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
540 /* can cleanly poll for disconnections without flickering the screen */
541 /* DACs should rarely do this without a lot of testing */
542 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
544 #define MAX_ELD_BYTES 128
547 * drm_connector - central DRM connector control structure
548 * @dev: parent DRM device
549 * @kdev: kernel device for sysfs attributes
550 * @attr: sysfs attributes
551 * @head: list management
552 * @base: base KMS object
553 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
554 * @connector_type_id: index into connector type enum
555 * @interlace_allowed: can this connector handle interlaced modes?
556 * @doublescan_allowed: can this connector handle doublescan?
557 * @modes: modes available on this connector (from fill_modes() + user)
558 * @status: one of the drm_connector_status enums (connected, not, or unknown)
559 * @probed_modes: list of modes derived directly from the display
560 * @display_info: information about attached display (e.g. from EDID)
561 * @funcs: connector control functions
562 * @edid_blob_ptr: DRM property containing EDID if present
563 * @properties: property tracking for this connector
564 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
565 * @dpms: current dpms state
566 * @helper_private: mid-layer private data
567 * @force: a %DRM_FORCE_<foo> state for forced mode sets
568 * @encoder_ids: valid encoders for this connector
569 * @encoder: encoder driving this connector, if any
570 * @eld: EDID-like data, if present
571 * @dvi_dual: dual link DVI, if found
572 * @max_tmds_clock: max clock rate, if found
573 * @latency_present: AV delay info from ELD, if found
574 * @video_latency: video latency info from ELD, if found
575 * @audio_latency: audio latency info from ELD, if found
576 * @null_edid_counter: track sinks that give us all zeros for the EDID
578 * Each connector may be connected to one or more CRTCs, or may be clonable by
579 * another connector if they can share a CRTC. Each connector also has a specific
580 * position in the broader display (referred to as a 'screen' though it could
581 * span multiple monitors).
583 struct drm_connector {
584 struct drm_device *dev;
586 struct device_attribute *attr;
587 struct list_head head;
589 struct drm_mode_object base;
592 int connector_type_id;
593 bool interlace_allowed;
594 bool doublescan_allowed;
595 struct list_head modes; /* list of modes on this connector */
597 enum drm_connector_status status;
599 /* these are modes added by probing with DDC or the BIOS */
600 struct list_head probed_modes;
602 struct drm_display_info display_info;
603 const struct drm_connector_funcs *funcs;
605 struct drm_property_blob *edid_blob_ptr;
606 struct drm_object_properties properties;
608 uint8_t polled; /* DRM_CONNECTOR_POLL_* */
610 /* requested DPMS state */
613 void *helper_private;
615 /* forced on connector */
616 enum drm_connector_force force;
617 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
618 struct drm_encoder *encoder; /* currently active encoder */
621 uint8_t eld[MAX_ELD_BYTES];
623 int max_tmds_clock; /* in MHz */
624 bool latency_present[2];
625 int video_latency[2]; /* [0]: progressive, [1]: interlaced */
626 int audio_latency[2];
627 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
628 unsigned bad_edid_counter;
632 * drm_plane_funcs - driver plane control functions
633 * @update_plane: update the plane configuration
634 * @disable_plane: shut down the plane
635 * @destroy: clean up plane resources
636 * @set_property: called when a property is changed
638 struct drm_plane_funcs {
639 int (*update_plane)(struct drm_plane *plane,
640 struct drm_crtc *crtc, struct drm_framebuffer *fb,
641 int crtc_x, int crtc_y,
642 unsigned int crtc_w, unsigned int crtc_h,
643 uint32_t src_x, uint32_t src_y,
644 uint32_t src_w, uint32_t src_h);
645 int (*disable_plane)(struct drm_plane *plane);
646 void (*destroy)(struct drm_plane *plane);
648 int (*set_property)(struct drm_plane *plane,
649 struct drm_property *property, uint64_t val);
653 * drm_plane - central DRM plane control structure
654 * @dev: DRM device this plane belongs to
655 * @head: for list management
656 * @base: base mode object
657 * @possible_crtcs: pipes this plane can be bound to
658 * @format_types: array of formats supported by this plane
659 * @format_count: number of formats supported
660 * @crtc: currently bound CRTC
661 * @fb: currently bound fb
662 * @funcs: helper functions
663 * @properties: property tracking for this plane
666 struct drm_device *dev;
667 struct list_head head;
669 struct drm_mode_object base;
671 uint32_t possible_crtcs;
672 uint32_t *format_types;
673 uint32_t format_count;
675 struct drm_crtc *crtc;
676 struct drm_framebuffer *fb;
678 const struct drm_plane_funcs *funcs;
680 struct drm_object_properties properties;
684 * drm_mode_set - new values for a CRTC config change
685 * @head: list management
686 * @fb: framebuffer to use for new config
687 * @crtc: CRTC whose configuration we're about to change
688 * @mode: mode timings to use
689 * @x: position of this CRTC relative to @fb
690 * @y: position of this CRTC relative to @fb
691 * @connectors: array of connectors to drive with this CRTC if possible
692 * @num_connectors: size of @connectors array
694 * Represents a single crtc the connectors that it drives with what mode
695 * and from which framebuffer it scans out from.
697 * This is used to set modes.
699 struct drm_mode_set {
700 struct drm_framebuffer *fb;
701 struct drm_crtc *crtc;
702 struct drm_display_mode *mode;
707 struct drm_connector **connectors;
708 size_t num_connectors;
712 * struct drm_mode_config_funcs - basic driver provided mode setting functions
713 * @fb_create: create a new framebuffer object
714 * @output_poll_changed: function to handle output configuration changes
716 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
719 struct drm_mode_config_funcs {
720 struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
721 struct drm_file *file_priv,
722 struct drm_mode_fb_cmd2 *mode_cmd);
723 void (*output_poll_changed)(struct drm_device *dev);
727 * drm_mode_group - group of mode setting resources for potential sub-grouping
728 * @num_crtcs: CRTC count
729 * @num_encoders: encoder count
730 * @num_connectors: connector count
731 * @id_list: list of KMS object IDs in this group
733 * Currently this simply tracks the global mode setting state. But in the
734 * future it could allow groups of objects to be set aside into independent
735 * control groups for use by different user level processes (e.g. two X servers
736 * running simultaneously on different heads, each with their own mode
737 * configuration and freedom of mode setting).
739 struct drm_mode_group {
741 uint32_t num_encoders;
742 uint32_t num_connectors;
744 /* list of object IDs for this group */
749 * drm_mode_config - Mode configuration control structure
750 * @mutex: mutex protecting KMS related lists and structures
751 * @idr_mutex: mutex for KMS ID allocation and management
752 * @crtc_idr: main KMS ID tracking object
753 * @num_fb: number of fbs available
754 * @fb_list: list of framebuffers available
755 * @num_connector: number of connectors on this device
756 * @connector_list: list of connector objects
757 * @num_encoder: number of encoders on this device
758 * @encoder_list: list of encoder objects
759 * @num_crtc: number of CRTCs on this device
760 * @crtc_list: list of CRTC objects
761 * @min_width: minimum pixel width on this device
762 * @min_height: minimum pixel height on this device
763 * @max_width: maximum pixel width on this device
764 * @max_height: maximum pixel height on this device
765 * @funcs: core driver provided mode setting functions
766 * @fb_base: base address of the framebuffer
767 * @poll_enabled: track polling status for this device
768 * @output_poll_work: delayed work for polling in process context
769 * @*_property: core property tracking
771 * Core mode resource tracking structure. All CRTC, encoders, and connectors
772 * enumerated by the driver are added here, as are global properties. Some
773 * global restrictions are also here, e.g. dimension restrictions.
775 struct drm_mode_config {
776 struct mutex mutex; /* protects configuration (mode lists etc.) */
777 struct mutex idr_mutex; /* for IDR management */
778 struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
779 /* this is limited to one for now */
783 * fb_lock - mutex to protect fb state
785 * Besides the global fb list his also protects the fbs list in the
788 struct mutex fb_lock;
790 struct list_head fb_list;
793 struct list_head connector_list;
795 struct list_head encoder_list;
797 struct list_head plane_list;
800 struct list_head crtc_list;
802 struct list_head property_list;
804 int min_width, min_height;
805 int max_width, max_height;
806 const struct drm_mode_config_funcs *funcs;
807 resource_size_t fb_base;
809 /* output poll support */
812 struct delayed_work output_poll_work;
814 /* pointers to standard properties */
815 struct list_head property_blob_list;
816 struct drm_property *edid_property;
817 struct drm_property *dpms_property;
819 /* DVI-I properties */
820 struct drm_property *dvi_i_subconnector_property;
821 struct drm_property *dvi_i_select_subconnector_property;
824 struct drm_property *tv_subconnector_property;
825 struct drm_property *tv_select_subconnector_property;
826 struct drm_property *tv_mode_property;
827 struct drm_property *tv_left_margin_property;
828 struct drm_property *tv_right_margin_property;
829 struct drm_property *tv_top_margin_property;
830 struct drm_property *tv_bottom_margin_property;
831 struct drm_property *tv_brightness_property;
832 struct drm_property *tv_contrast_property;
833 struct drm_property *tv_flicker_reduction_property;
834 struct drm_property *tv_overscan_property;
835 struct drm_property *tv_saturation_property;
836 struct drm_property *tv_hue_property;
838 /* Optional properties */
839 struct drm_property *scaling_mode_property;
840 struct drm_property *dithering_mode_property;
841 struct drm_property *dirty_info_property;
843 /* dumb ioctl parameters */
844 uint32_t preferred_depth, prefer_shadow;
847 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
848 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
849 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
850 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
851 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
852 #define obj_to_property(x) container_of(x, struct drm_property, base)
853 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
854 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
856 struct drm_prop_enum_list {
861 extern void drm_modeset_lock_all(struct drm_device *dev);
862 extern void drm_modeset_unlock_all(struct drm_device *dev);
863 extern void drm_warn_on_modeset_not_all_locked(struct drm_device *dev);
865 extern int drm_crtc_init(struct drm_device *dev,
866 struct drm_crtc *crtc,
867 const struct drm_crtc_funcs *funcs);
868 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
870 extern void drm_connector_ida_init(void);
871 extern void drm_connector_ida_destroy(void);
872 extern int drm_connector_init(struct drm_device *dev,
873 struct drm_connector *connector,
874 const struct drm_connector_funcs *funcs,
877 extern void drm_connector_cleanup(struct drm_connector *connector);
878 /* helper to unplug all connectors from sysfs for device */
879 extern void drm_connector_unplug_all(struct drm_device *dev);
881 extern int drm_encoder_init(struct drm_device *dev,
882 struct drm_encoder *encoder,
883 const struct drm_encoder_funcs *funcs,
886 extern int drm_plane_init(struct drm_device *dev,
887 struct drm_plane *plane,
888 unsigned long possible_crtcs,
889 const struct drm_plane_funcs *funcs,
890 const uint32_t *formats, uint32_t format_count,
892 extern void drm_plane_cleanup(struct drm_plane *plane);
893 extern void drm_plane_force_disable(struct drm_plane *plane);
895 extern void drm_encoder_cleanup(struct drm_encoder *encoder);
897 extern const char *drm_get_connector_name(const struct drm_connector *connector);
898 extern const char *drm_get_connector_status_name(enum drm_connector_status status);
899 extern const char *drm_get_dpms_name(int val);
900 extern const char *drm_get_dvi_i_subconnector_name(int val);
901 extern const char *drm_get_dvi_i_select_name(int val);
902 extern const char *drm_get_tv_subconnector_name(int val);
903 extern const char *drm_get_tv_select_name(int val);
904 extern void drm_fb_release(struct drm_file *file_priv);
905 extern int drm_mode_group_init_legacy_group(struct drm_device *dev, struct drm_mode_group *group);
906 extern bool drm_probe_ddc(struct i2c_adapter *adapter);
907 extern struct edid *drm_get_edid(struct drm_connector *connector,
908 struct i2c_adapter *adapter);
909 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
910 extern void drm_mode_probed_add(struct drm_connector *connector, struct drm_display_mode *mode);
911 extern void drm_mode_copy(struct drm_display_mode *dst, const struct drm_display_mode *src);
912 extern struct drm_display_mode *drm_mode_duplicate(struct drm_device *dev,
913 const struct drm_display_mode *mode);
914 extern void drm_mode_debug_printmodeline(const struct drm_display_mode *mode);
915 extern void drm_mode_config_init(struct drm_device *dev);
916 extern void drm_mode_config_reset(struct drm_device *dev);
917 extern void drm_mode_config_cleanup(struct drm_device *dev);
918 extern void drm_mode_set_name(struct drm_display_mode *mode);
919 extern bool drm_mode_equal(const struct drm_display_mode *mode1, const struct drm_display_mode *mode2);
920 extern bool drm_mode_equal_no_clocks(const struct drm_display_mode *mode1, const struct drm_display_mode *mode2);
921 extern int drm_mode_width(const struct drm_display_mode *mode);
922 extern int drm_mode_height(const struct drm_display_mode *mode);
924 /* for us by fb module */
925 extern struct drm_display_mode *drm_mode_create(struct drm_device *dev);
926 extern void drm_mode_destroy(struct drm_device *dev, struct drm_display_mode *mode);
927 extern void drm_mode_validate_size(struct drm_device *dev,
928 struct list_head *mode_list,
929 int maxX, int maxY, int maxPitch);
930 extern void drm_mode_prune_invalid(struct drm_device *dev,
931 struct list_head *mode_list, bool verbose);
932 extern void drm_mode_sort(struct list_head *mode_list);
933 extern int drm_mode_hsync(const struct drm_display_mode *mode);
934 extern int drm_mode_vrefresh(const struct drm_display_mode *mode);
935 extern void drm_mode_set_crtcinfo(struct drm_display_mode *p,
937 extern void drm_mode_connector_list_update(struct drm_connector *connector);
938 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
940 extern int drm_object_property_set_value(struct drm_mode_object *obj,
941 struct drm_property *property,
943 extern int drm_object_property_get_value(struct drm_mode_object *obj,
944 struct drm_property *property,
946 extern int drm_framebuffer_init(struct drm_device *dev,
947 struct drm_framebuffer *fb,
948 const struct drm_framebuffer_funcs *funcs);
949 extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
951 extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
952 extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
953 extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
954 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
955 extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
957 extern void drm_object_attach_property(struct drm_mode_object *obj,
958 struct drm_property *property,
960 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
961 const char *name, int num_values);
962 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
964 const struct drm_prop_enum_list *props,
966 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
967 int flags, const char *name,
968 const struct drm_prop_enum_list *props,
970 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
972 uint64_t min, uint64_t max);
973 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
974 extern int drm_property_add_enum(struct drm_property *property, int index,
975 uint64_t value, const char *name);
976 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
977 extern int drm_mode_create_tv_properties(struct drm_device *dev, int num_formats,
979 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
980 extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
981 extern const char *drm_get_encoder_name(const struct drm_encoder *encoder);
983 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
984 struct drm_encoder *encoder);
985 extern void drm_mode_connector_detach_encoder(struct drm_connector *connector,
986 struct drm_encoder *encoder);
987 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
989 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
990 uint32_t id, uint32_t type);
992 extern int drm_mode_getresources(struct drm_device *dev,
993 void *data, struct drm_file *file_priv);
994 extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
995 struct drm_file *file_priv);
996 extern int drm_mode_getcrtc(struct drm_device *dev,
997 void *data, struct drm_file *file_priv);
998 extern int drm_mode_getconnector(struct drm_device *dev,
999 void *data, struct drm_file *file_priv);
1000 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
1001 extern int drm_mode_setcrtc(struct drm_device *dev,
1002 void *data, struct drm_file *file_priv);
1003 extern int drm_mode_getplane(struct drm_device *dev,
1004 void *data, struct drm_file *file_priv);
1005 extern int drm_mode_setplane(struct drm_device *dev,
1006 void *data, struct drm_file *file_priv);
1007 extern int drm_mode_cursor_ioctl(struct drm_device *dev,
1008 void *data, struct drm_file *file_priv);
1009 extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
1010 void *data, struct drm_file *file_priv);
1011 extern int drm_mode_addfb(struct drm_device *dev,
1012 void *data, struct drm_file *file_priv);
1013 extern int drm_mode_addfb2(struct drm_device *dev,
1014 void *data, struct drm_file *file_priv);
1015 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
1016 extern int drm_mode_rmfb(struct drm_device *dev,
1017 void *data, struct drm_file *file_priv);
1018 extern int drm_mode_getfb(struct drm_device *dev,
1019 void *data, struct drm_file *file_priv);
1020 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1021 void *data, struct drm_file *file_priv);
1023 extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1024 void *data, struct drm_file *file_priv);
1025 extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1026 void *data, struct drm_file *file_priv);
1027 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1028 void *data, struct drm_file *file_priv);
1029 extern int drm_mode_getencoder(struct drm_device *dev,
1030 void *data, struct drm_file *file_priv);
1031 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1032 void *data, struct drm_file *file_priv);
1033 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1034 void *data, struct drm_file *file_priv);
1035 extern u8 *drm_find_cea_extension(struct edid *edid);
1036 extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
1037 extern bool drm_detect_hdmi_monitor(struct edid *edid);
1038 extern bool drm_detect_monitor_audio(struct edid *edid);
1039 extern bool drm_rgb_quant_range_selectable(struct edid *edid);
1040 extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1041 void *data, struct drm_file *file_priv);
1042 extern struct drm_display_mode *drm_cvt_mode(struct drm_device *dev,
1043 int hdisplay, int vdisplay, int vrefresh,
1044 bool reduced, bool interlaced, bool margins);
1045 extern struct drm_display_mode *drm_gtf_mode(struct drm_device *dev,
1046 int hdisplay, int vdisplay, int vrefresh,
1047 bool interlaced, int margins);
1048 extern struct drm_display_mode *drm_gtf_mode_complex(struct drm_device *dev,
1049 int hdisplay, int vdisplay, int vrefresh,
1050 bool interlaced, int margins, int GTF_M,
1051 int GTF_2C, int GTF_K, int GTF_2J);
1052 extern int drm_add_modes_noedid(struct drm_connector *connector,
1053 int hdisplay, int vdisplay);
1055 extern int drm_edid_header_is_valid(const u8 *raw_edid);
1056 extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid);
1057 extern bool drm_edid_is_valid(struct edid *edid);
1058 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
1059 int hsize, int vsize, int fresh,
1062 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1063 void *data, struct drm_file *file_priv);
1064 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1065 void *data, struct drm_file *file_priv);
1066 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1067 void *data, struct drm_file *file_priv);
1068 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1069 struct drm_file *file_priv);
1070 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1071 struct drm_file *file_priv);
1073 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1075 extern int drm_format_num_planes(uint32_t format);
1076 extern int drm_format_plane_cpp(uint32_t format, int plane);
1077 extern int drm_format_horz_chroma_subsampling(uint32_t format);
1078 extern int drm_format_vert_chroma_subsampling(uint32_t format);
1079 extern const char *drm_get_format_name(uint32_t format);
1081 #endif /* __DRM_CRTC_H__ */