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>
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
52 #define DRM_MODE_OBJECT_BRIDGE 0xbdbdbdbd
54 struct drm_mode_object {
57 struct drm_object_properties *properties;
60 #define DRM_OBJECT_MAX_PROPERTY 24
61 struct drm_object_properties {
63 uint32_t ids[DRM_OBJECT_MAX_PROPERTY];
64 uint64_t values[DRM_OBJECT_MAX_PROPERTY];
67 enum drm_connector_force {
68 DRM_FORCE_UNSPECIFIED,
70 DRM_FORCE_ON, /* force on analog part normally */
71 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
74 #include <drm/drm_modes.h>
76 enum drm_connector_status {
77 connector_status_connected = 1,
78 connector_status_disconnected = 2,
79 connector_status_unknown = 3,
84 SubPixelHorizontalRGB,
85 SubPixelHorizontalBGR,
91 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
92 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
93 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
95 * Describes a given display (e.g. CRT or flat panel) and its limitations.
97 struct drm_display_info {
98 char name[DRM_DISPLAY_INFO_LEN];
101 unsigned int width_mm;
102 unsigned int height_mm;
104 /* Clock limits FIXME: storage format */
105 unsigned int min_vfreq, max_vfreq;
106 unsigned int min_hfreq, max_hfreq;
107 unsigned int pixel_clock;
110 enum subpixel_order subpixel_order;
116 struct drm_framebuffer_funcs {
117 /* note: use drm_framebuffer_remove() */
118 void (*destroy)(struct drm_framebuffer *framebuffer);
119 int (*create_handle)(struct drm_framebuffer *fb,
120 struct drm_file *file_priv,
121 unsigned int *handle);
123 * Optinal callback for the dirty fb ioctl.
125 * Userspace can notify the driver via this callback
126 * that a area of the framebuffer has changed and should
127 * be flushed to the display hardware.
129 * See documentation in drm_mode.h for the struct
130 * drm_mode_fb_dirty_cmd for more information as all
131 * the semantics and arguments have a one to one mapping
134 int (*dirty)(struct drm_framebuffer *framebuffer,
135 struct drm_file *file_priv, unsigned flags,
136 unsigned color, struct drm_clip_rect *clips,
140 struct drm_framebuffer {
141 struct drm_device *dev;
143 * Note that the fb is refcounted for the benefit of driver internals,
144 * for example some hw, disabling a CRTC/plane is asynchronous, and
145 * scanout does not actually complete until the next vblank. So some
146 * cleanup (like releasing the reference(s) on the backing GEM bo(s))
147 * should be deferred. In cases like this, the driver would like to
148 * hold a ref to the fb even though it has already been removed from
149 * userspace perspective.
151 struct kref refcount;
153 * Place on the dev->mode_config.fb_list, access protected by
154 * dev->mode_config.fb_lock.
156 struct list_head head;
157 struct drm_mode_object base;
158 const struct drm_framebuffer_funcs *funcs;
159 unsigned int pitches[4];
160 unsigned int offsets[4];
163 /* depth can be 15 or 16 */
167 uint32_t pixel_format; /* fourcc format */
168 struct list_head filp_head;
169 /* if you are using the helper */
170 void *helper_private;
173 struct drm_property_blob {
174 struct drm_mode_object base;
175 struct list_head head;
177 unsigned char data[];
180 struct drm_property_enum {
182 struct list_head head;
183 char name[DRM_PROP_NAME_LEN];
186 struct drm_property {
187 struct list_head head;
188 struct drm_mode_object base;
190 char name[DRM_PROP_NAME_LEN];
194 struct list_head enum_blob_list;
198 struct drm_connector;
200 struct drm_pending_vblank_event;
205 * drm_crtc_funcs - control CRTCs for a given device
206 * @save: save CRTC state
207 * @restore: restore CRTC state
208 * @reset: reset CRTC after state has been invalidated (e.g. resume)
209 * @cursor_set: setup the cursor
210 * @cursor_move: move the cursor
211 * @gamma_set: specify color ramp for CRTC
212 * @destroy: deinit and free object
213 * @set_property: called when a property is changed
214 * @set_config: apply a new CRTC configuration
215 * @page_flip: initiate a page flip
217 * The drm_crtc_funcs structure is the central CRTC management structure
218 * in the DRM. Each CRTC controls one or more connectors (note that the name
219 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
220 * connectors, not just CRTs).
222 * Each driver is responsible for filling out this structure at startup time,
223 * in addition to providing other modesetting features, like i2c and DDC
226 struct drm_crtc_funcs {
227 /* Save CRTC state */
228 void (*save)(struct drm_crtc *crtc); /* suspend? */
229 /* Restore CRTC state */
230 void (*restore)(struct drm_crtc *crtc); /* resume? */
231 /* Reset CRTC state */
232 void (*reset)(struct drm_crtc *crtc);
234 /* cursor controls */
235 int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
236 uint32_t handle, uint32_t width, uint32_t height);
237 int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
238 uint32_t handle, uint32_t width, uint32_t height,
239 int32_t hot_x, int32_t hot_y);
240 int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
242 /* Set gamma on the CRTC */
243 void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
244 uint32_t start, uint32_t size);
245 /* Object destroy routine */
246 void (*destroy)(struct drm_crtc *crtc);
248 int (*set_config)(struct drm_mode_set *set);
251 * Flip to the given framebuffer. This implements the page
252 * flip ioctl described in drm_mode.h, specifically, the
253 * implementation must return immediately and block all
254 * rendering to the current fb until the flip has completed.
255 * If userspace set the event flag in the ioctl, the event
256 * argument will point to an event to send back when the flip
257 * completes, otherwise it will be NULL.
259 int (*page_flip)(struct drm_crtc *crtc,
260 struct drm_framebuffer *fb,
261 struct drm_pending_vblank_event *event,
264 int (*set_property)(struct drm_crtc *crtc,
265 struct drm_property *property, uint64_t val);
269 * drm_crtc - central CRTC control structure
270 * @dev: parent DRM device
271 * @head: list management
272 * @base: base KMS object for ID tracking etc.
273 * @primary: primary plane for this CRTC
274 * @cursor: cursor plane for this CRTC
275 * @enabled: is this CRTC enabled?
276 * @mode: current mode timings
277 * @hwmode: mode timings as programmed to hw regs
278 * @invert_dimensions: for purposes of error checking crtc vs fb sizes,
279 * invert the width/height of the crtc. This is used if the driver
280 * is performing 90 or 270 degree rotated scanout
281 * @x: x position on screen
282 * @y: y position on screen
283 * @funcs: CRTC control functions
284 * @gamma_size: size of gamma ramp
285 * @gamma_store: gamma ramp values
286 * @framedur_ns: precise frame timing
287 * @framedur_ns: precise line timing
288 * @pixeldur_ns: precise pixel timing
289 * @helper_private: mid-layer private data
290 * @properties: property tracking for this CRTC
292 * Each CRTC may have one or more connectors associated with it. This structure
293 * allows the CRTC to be controlled.
296 struct drm_device *dev;
297 struct list_head head;
302 * This provides a read lock for the overall crtc state (mode, dpms
303 * state, ...) and a write lock for everything which can be update
304 * without a full modeset (fb, cursor data, ...)
308 struct drm_mode_object base;
310 /* primary and cursor planes for CRTC */
311 struct drm_plane *primary;
312 struct drm_plane *cursor;
314 /* Temporary tracking of the old fb while a modeset is ongoing. Used
315 * by drm_mode_set_config_internal to implement correct refcounting. */
316 struct drm_framebuffer *old_fb;
320 /* Requested mode from modesetting. */
321 struct drm_display_mode mode;
323 /* Programmed mode in hw, after adjustments for encoders,
324 * crtc, panel scaling etc. Needed for timestamping etc.
326 struct drm_display_mode hwmode;
328 bool invert_dimensions;
331 const struct drm_crtc_funcs *funcs;
333 /* CRTC gamma size for reporting to userspace */
335 uint16_t *gamma_store;
337 /* Constants needed for precise vblank and swap timestamping. */
338 int framedur_ns, linedur_ns, pixeldur_ns;
340 /* if you are using the helper */
341 void *helper_private;
343 struct drm_object_properties properties;
348 * drm_connector_funcs - control connectors on a given device
349 * @dpms: set power state (see drm_crtc_funcs above)
350 * @save: save connector state
351 * @restore: restore connector state
352 * @reset: reset connector after state has been invalidated (e.g. resume)
353 * @detect: is this connector active?
354 * @fill_modes: fill mode list for this connector
355 * @set_property: property for this connector may need an update
356 * @destroy: make object go away
357 * @force: notify the driver that the connector is forced on
359 * Each CRTC may have one or more connectors attached to it. The functions
360 * below allow the core DRM code to control connectors, enumerate available modes,
363 struct drm_connector_funcs {
364 void (*dpms)(struct drm_connector *connector, int mode);
365 void (*save)(struct drm_connector *connector);
366 void (*restore)(struct drm_connector *connector);
367 void (*reset)(struct drm_connector *connector);
369 /* Check to see if anything is attached to the connector.
370 * @force is set to false whilst polling, true when checking the
371 * connector due to user request. @force can be used by the driver
372 * to avoid expensive, destructive operations during automated
375 enum drm_connector_status (*detect)(struct drm_connector *connector,
377 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
378 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
380 void (*destroy)(struct drm_connector *connector);
381 void (*force)(struct drm_connector *connector);
385 * drm_encoder_funcs - encoder controls
386 * @reset: reset state (e.g. at init or resume time)
387 * @destroy: cleanup and free associated data
389 * Encoders sit between CRTCs and connectors.
391 struct drm_encoder_funcs {
392 void (*reset)(struct drm_encoder *encoder);
393 void (*destroy)(struct drm_encoder *encoder);
396 #define DRM_CONNECTOR_MAX_ENCODER 3
399 * drm_encoder - central DRM encoder structure
400 * @dev: parent DRM device
401 * @head: list management
402 * @base: base KMS object
403 * @name: encoder name
404 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
405 * @possible_crtcs: bitmask of potential CRTC bindings
406 * @possible_clones: bitmask of potential sibling encoders for cloning
407 * @crtc: currently bound CRTC
408 * @bridge: bridge associated to the encoder
409 * @funcs: control functions
410 * @helper_private: mid-layer private data
412 * CRTCs drive pixels to encoders, which convert them into signals
413 * appropriate for a given connector or set of connectors.
416 struct drm_device *dev;
417 struct list_head head;
419 struct drm_mode_object base;
422 uint32_t possible_crtcs;
423 uint32_t possible_clones;
425 struct drm_crtc *crtc;
426 struct drm_bridge *bridge;
427 const struct drm_encoder_funcs *funcs;
428 void *helper_private;
431 /* should we poll this connector for connects and disconnects */
432 /* hot plug detectable */
433 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
434 /* poll for connections */
435 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
436 /* can cleanly poll for disconnections without flickering the screen */
437 /* DACs should rarely do this without a lot of testing */
438 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
440 #define MAX_ELD_BYTES 128
443 * drm_connector - central DRM connector control structure
444 * @dev: parent DRM device
445 * @kdev: kernel device for sysfs attributes
446 * @attr: sysfs attributes
447 * @head: list management
448 * @base: base KMS object
449 * @name: connector name
450 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
451 * @connector_type_id: index into connector type enum
452 * @interlace_allowed: can this connector handle interlaced modes?
453 * @doublescan_allowed: can this connector handle doublescan?
454 * @modes: modes available on this connector (from fill_modes() + user)
455 * @status: one of the drm_connector_status enums (connected, not, or unknown)
456 * @probed_modes: list of modes derived directly from the display
457 * @display_info: information about attached display (e.g. from EDID)
458 * @funcs: connector control functions
459 * @edid_blob_ptr: DRM property containing EDID if present
460 * @properties: property tracking for this connector
461 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
462 * @dpms: current dpms state
463 * @helper_private: mid-layer private data
464 * @force: a %DRM_FORCE_<foo> state for forced mode sets
465 * @encoder_ids: valid encoders for this connector
466 * @encoder: encoder driving this connector, if any
467 * @eld: EDID-like data, if present
468 * @dvi_dual: dual link DVI, if found
469 * @max_tmds_clock: max clock rate, if found
470 * @latency_present: AV delay info from ELD, if found
471 * @video_latency: video latency info from ELD, if found
472 * @audio_latency: audio latency info from ELD, if found
473 * @null_edid_counter: track sinks that give us all zeros for the EDID
475 * Each connector may be connected to one or more CRTCs, or may be clonable by
476 * another connector if they can share a CRTC. Each connector also has a specific
477 * position in the broader display (referred to as a 'screen' though it could
478 * span multiple monitors).
480 struct drm_connector {
481 struct drm_device *dev;
483 struct device_attribute *attr;
484 struct list_head head;
486 struct drm_mode_object base;
490 int connector_type_id;
491 bool interlace_allowed;
492 bool doublescan_allowed;
494 struct list_head modes; /* list of modes on this connector */
496 enum drm_connector_status status;
498 /* these are modes added by probing with DDC or the BIOS */
499 struct list_head probed_modes;
501 struct drm_display_info display_info;
502 const struct drm_connector_funcs *funcs;
504 struct drm_property_blob *edid_blob_ptr;
505 struct drm_object_properties properties;
507 uint8_t polled; /* DRM_CONNECTOR_POLL_* */
509 /* requested DPMS state */
512 void *helper_private;
514 /* forced on connector */
515 enum drm_connector_force force;
516 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
517 struct drm_encoder *encoder; /* currently active encoder */
520 uint8_t eld[MAX_ELD_BYTES];
522 int max_tmds_clock; /* in MHz */
523 bool latency_present[2];
524 int video_latency[2]; /* [0]: progressive, [1]: interlaced */
525 int audio_latency[2];
526 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
527 unsigned bad_edid_counter;
531 * drm_plane_funcs - driver plane control functions
532 * @update_plane: update the plane configuration
533 * @disable_plane: shut down the plane
534 * @destroy: clean up plane resources
535 * @set_property: called when a property is changed
537 struct drm_plane_funcs {
538 int (*update_plane)(struct drm_plane *plane,
539 struct drm_crtc *crtc, struct drm_framebuffer *fb,
540 int crtc_x, int crtc_y,
541 unsigned int crtc_w, unsigned int crtc_h,
542 uint32_t src_x, uint32_t src_y,
543 uint32_t src_w, uint32_t src_h);
544 int (*disable_plane)(struct drm_plane *plane);
545 void (*destroy)(struct drm_plane *plane);
547 int (*set_property)(struct drm_plane *plane,
548 struct drm_property *property, uint64_t val);
551 enum drm_plane_type {
552 DRM_PLANE_TYPE_OVERLAY,
553 DRM_PLANE_TYPE_PRIMARY,
554 DRM_PLANE_TYPE_CURSOR,
558 * drm_plane - central DRM plane control structure
559 * @dev: DRM device this plane belongs to
560 * @head: for list management
561 * @base: base mode object
562 * @possible_crtcs: pipes this plane can be bound to
563 * @format_types: array of formats supported by this plane
564 * @format_count: number of formats supported
565 * @crtc: currently bound CRTC
566 * @fb: currently bound fb
567 * @funcs: helper functions
568 * @properties: property tracking for this plane
569 * @type: type of plane (overlay, primary, cursor)
572 struct drm_device *dev;
573 struct list_head head;
575 struct drm_mode_object base;
577 uint32_t possible_crtcs;
578 uint32_t *format_types;
579 uint32_t format_count;
581 struct drm_crtc *crtc;
582 struct drm_framebuffer *fb;
584 const struct drm_plane_funcs *funcs;
586 struct drm_object_properties properties;
588 enum drm_plane_type type;
592 * drm_bridge_funcs - drm_bridge control functions
593 * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
594 * @disable: Called right before encoder prepare, disables the bridge
595 * @post_disable: Called right after encoder prepare, for lockstepped disable
596 * @mode_set: Set this mode to the bridge
597 * @pre_enable: Called right before encoder commit, for lockstepped commit
598 * @enable: Called right after encoder commit, enables the bridge
599 * @destroy: make object go away
601 struct drm_bridge_funcs {
602 bool (*mode_fixup)(struct drm_bridge *bridge,
603 const struct drm_display_mode *mode,
604 struct drm_display_mode *adjusted_mode);
605 void (*disable)(struct drm_bridge *bridge);
606 void (*post_disable)(struct drm_bridge *bridge);
607 void (*mode_set)(struct drm_bridge *bridge,
608 struct drm_display_mode *mode,
609 struct drm_display_mode *adjusted_mode);
610 void (*pre_enable)(struct drm_bridge *bridge);
611 void (*enable)(struct drm_bridge *bridge);
612 void (*destroy)(struct drm_bridge *bridge);
616 * drm_bridge - central DRM bridge control structure
617 * @dev: DRM device this bridge belongs to
618 * @head: list management
619 * @base: base mode object
620 * @funcs: control functions
621 * @driver_private: pointer to the bridge driver's internal context
624 struct drm_device *dev;
625 struct list_head head;
627 struct drm_mode_object base;
629 const struct drm_bridge_funcs *funcs;
630 void *driver_private;
634 * drm_mode_set - new values for a CRTC config change
635 * @head: list management
636 * @fb: framebuffer to use for new config
637 * @crtc: CRTC whose configuration we're about to change
638 * @mode: mode timings to use
639 * @x: position of this CRTC relative to @fb
640 * @y: position of this CRTC relative to @fb
641 * @connectors: array of connectors to drive with this CRTC if possible
642 * @num_connectors: size of @connectors array
644 * Represents a single crtc the connectors that it drives with what mode
645 * and from which framebuffer it scans out from.
647 * This is used to set modes.
649 struct drm_mode_set {
650 struct drm_framebuffer *fb;
651 struct drm_crtc *crtc;
652 struct drm_display_mode *mode;
657 struct drm_connector **connectors;
658 size_t num_connectors;
662 * struct drm_mode_config_funcs - basic driver provided mode setting functions
663 * @fb_create: create a new framebuffer object
664 * @output_poll_changed: function to handle output configuration changes
666 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
669 struct drm_mode_config_funcs {
670 struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
671 struct drm_file *file_priv,
672 struct drm_mode_fb_cmd2 *mode_cmd);
673 void (*output_poll_changed)(struct drm_device *dev);
677 * drm_mode_group - group of mode setting resources for potential sub-grouping
678 * @num_crtcs: CRTC count
679 * @num_encoders: encoder count
680 * @num_connectors: connector count
681 * @id_list: list of KMS object IDs in this group
683 * Currently this simply tracks the global mode setting state. But in the
684 * future it could allow groups of objects to be set aside into independent
685 * control groups for use by different user level processes (e.g. two X servers
686 * running simultaneously on different heads, each with their own mode
687 * configuration and freedom of mode setting).
689 struct drm_mode_group {
691 uint32_t num_encoders;
692 uint32_t num_connectors;
693 uint32_t num_bridges;
695 /* list of object IDs for this group */
700 * drm_mode_config - Mode configuration control structure
701 * @mutex: mutex protecting KMS related lists and structures
702 * @idr_mutex: mutex for KMS ID allocation and management
703 * @crtc_idr: main KMS ID tracking object
704 * @num_fb: number of fbs available
705 * @fb_list: list of framebuffers available
706 * @num_connector: number of connectors on this device
707 * @connector_list: list of connector objects
708 * @num_bridge: number of bridges on this device
709 * @bridge_list: list of bridge objects
710 * @num_encoder: number of encoders on this device
711 * @encoder_list: list of encoder objects
712 * @num_crtc: number of CRTCs on this device
713 * @crtc_list: list of CRTC objects
714 * @min_width: minimum pixel width on this device
715 * @min_height: minimum pixel height on this device
716 * @max_width: maximum pixel width on this device
717 * @max_height: maximum pixel height on this device
718 * @funcs: core driver provided mode setting functions
719 * @fb_base: base address of the framebuffer
720 * @poll_enabled: track polling status for this device
721 * @output_poll_work: delayed work for polling in process context
722 * @*_property: core property tracking
724 * Core mode resource tracking structure. All CRTC, encoders, and connectors
725 * enumerated by the driver are added here, as are global properties. Some
726 * global restrictions are also here, e.g. dimension restrictions.
728 struct drm_mode_config {
729 struct mutex mutex; /* protects configuration (mode lists etc.) */
730 struct mutex idr_mutex; /* for IDR management */
731 struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
732 /* this is limited to one for now */
736 * fb_lock - mutex to protect fb state
738 * Besides the global fb list his also protects the fbs list in the
741 struct mutex fb_lock;
743 struct list_head fb_list;
746 struct list_head connector_list;
748 struct list_head bridge_list;
750 struct list_head encoder_list;
753 * Track # of overlay planes separately from # of total planes. By
754 * default we only advertise overlay planes to userspace; if userspace
755 * sets the "universal plane" capability bit, we'll go ahead and
758 int num_overlay_plane;
760 struct list_head plane_list;
763 struct list_head crtc_list;
765 struct list_head property_list;
767 int min_width, min_height;
768 int max_width, max_height;
769 const struct drm_mode_config_funcs *funcs;
770 resource_size_t fb_base;
772 /* output poll support */
775 struct delayed_work output_poll_work;
777 /* pointers to standard properties */
778 struct list_head property_blob_list;
779 struct drm_property *edid_property;
780 struct drm_property *dpms_property;
781 struct drm_property *plane_type_property;
783 /* DVI-I properties */
784 struct drm_property *dvi_i_subconnector_property;
785 struct drm_property *dvi_i_select_subconnector_property;
788 struct drm_property *tv_subconnector_property;
789 struct drm_property *tv_select_subconnector_property;
790 struct drm_property *tv_mode_property;
791 struct drm_property *tv_left_margin_property;
792 struct drm_property *tv_right_margin_property;
793 struct drm_property *tv_top_margin_property;
794 struct drm_property *tv_bottom_margin_property;
795 struct drm_property *tv_brightness_property;
796 struct drm_property *tv_contrast_property;
797 struct drm_property *tv_flicker_reduction_property;
798 struct drm_property *tv_overscan_property;
799 struct drm_property *tv_saturation_property;
800 struct drm_property *tv_hue_property;
802 /* Optional properties */
803 struct drm_property *scaling_mode_property;
804 struct drm_property *dirty_info_property;
806 /* dumb ioctl parameters */
807 uint32_t preferred_depth, prefer_shadow;
809 /* whether async page flip is supported or not */
810 bool async_page_flip;
813 uint32_t cursor_width, cursor_height;
816 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
817 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
818 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
819 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
820 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
821 #define obj_to_property(x) container_of(x, struct drm_property, base)
822 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
823 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
825 struct drm_prop_enum_list {
830 extern void drm_modeset_lock_all(struct drm_device *dev);
831 extern void drm_modeset_unlock_all(struct drm_device *dev);
832 extern void drm_warn_on_modeset_not_all_locked(struct drm_device *dev);
834 extern int drm_crtc_init_with_planes(struct drm_device *dev,
835 struct drm_crtc *crtc,
836 struct drm_plane *primary,
838 const struct drm_crtc_funcs *funcs);
839 extern int drm_crtc_init(struct drm_device *dev,
840 struct drm_crtc *crtc,
841 const struct drm_crtc_funcs *funcs);
842 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
843 extern unsigned int drm_crtc_index(struct drm_crtc *crtc);
846 * drm_crtc_mask - find the mask of a registered CRTC
847 * @crtc: CRTC to find mask for
849 * Given a registered CRTC, return the mask bit of that CRTC for an
850 * encoder's possible_crtcs field.
852 static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
854 return 1 << drm_crtc_index(crtc);
857 extern void drm_connector_ida_init(void);
858 extern void drm_connector_ida_destroy(void);
859 extern int drm_connector_init(struct drm_device *dev,
860 struct drm_connector *connector,
861 const struct drm_connector_funcs *funcs,
864 extern void drm_connector_cleanup(struct drm_connector *connector);
865 /* helper to unplug all connectors from sysfs for device */
866 extern void drm_connector_unplug_all(struct drm_device *dev);
868 extern int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge,
869 const struct drm_bridge_funcs *funcs);
870 extern void drm_bridge_cleanup(struct drm_bridge *bridge);
872 extern int drm_encoder_init(struct drm_device *dev,
873 struct drm_encoder *encoder,
874 const struct drm_encoder_funcs *funcs,
878 * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
879 * @encoder: encoder to test
880 * @crtc: crtc to test
882 * Return false if @encoder can't be driven by @crtc, true otherwise.
884 static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
885 struct drm_crtc *crtc)
887 return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
890 extern int drm_universal_plane_init(struct drm_device *dev,
891 struct drm_plane *plane,
892 unsigned long possible_crtcs,
893 const struct drm_plane_funcs *funcs,
894 const uint32_t *formats,
895 uint32_t format_count,
896 enum drm_plane_type type);
897 extern int drm_plane_init(struct drm_device *dev,
898 struct drm_plane *plane,
899 unsigned long possible_crtcs,
900 const struct drm_plane_funcs *funcs,
901 const uint32_t *formats, uint32_t format_count,
903 extern void drm_plane_cleanup(struct drm_plane *plane);
904 extern void drm_plane_force_disable(struct drm_plane *plane);
905 extern int drm_crtc_check_viewport(const struct drm_crtc *crtc,
907 const struct drm_display_mode *mode,
908 const struct drm_framebuffer *fb);
910 extern void drm_encoder_cleanup(struct drm_encoder *encoder);
912 extern const char *drm_get_connector_status_name(enum drm_connector_status status);
913 extern const char *drm_get_subpixel_order_name(enum subpixel_order order);
914 extern const char *drm_get_dpms_name(int val);
915 extern const char *drm_get_dvi_i_subconnector_name(int val);
916 extern const char *drm_get_dvi_i_select_name(int val);
917 extern const char *drm_get_tv_subconnector_name(int val);
918 extern const char *drm_get_tv_select_name(int val);
919 extern void drm_fb_release(struct drm_file *file_priv);
920 extern int drm_mode_group_init_legacy_group(struct drm_device *dev, struct drm_mode_group *group);
921 extern void drm_mode_group_destroy(struct drm_mode_group *group);
922 extern bool drm_probe_ddc(struct i2c_adapter *adapter);
923 extern struct edid *drm_get_edid(struct drm_connector *connector,
924 struct i2c_adapter *adapter);
925 extern struct edid *drm_edid_duplicate(const struct edid *edid);
926 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
927 extern void drm_mode_config_init(struct drm_device *dev);
928 extern void drm_mode_config_reset(struct drm_device *dev);
929 extern void drm_mode_config_cleanup(struct drm_device *dev);
931 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
933 extern int drm_object_property_set_value(struct drm_mode_object *obj,
934 struct drm_property *property,
936 extern int drm_object_property_get_value(struct drm_mode_object *obj,
937 struct drm_property *property,
939 extern int drm_framebuffer_init(struct drm_device *dev,
940 struct drm_framebuffer *fb,
941 const struct drm_framebuffer_funcs *funcs);
942 extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
944 extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
945 extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
946 extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
947 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
948 extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
950 extern void drm_object_attach_property(struct drm_mode_object *obj,
951 struct drm_property *property,
953 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
954 const char *name, int num_values);
955 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
957 const struct drm_prop_enum_list *props,
959 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
960 int flags, const char *name,
961 const struct drm_prop_enum_list *props,
963 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
965 uint64_t min, uint64_t max);
966 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
967 extern int drm_property_add_enum(struct drm_property *property, int index,
968 uint64_t value, const char *name);
969 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
970 extern int drm_mode_create_tv_properties(struct drm_device *dev, int num_formats,
972 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
973 extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
975 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
976 struct drm_encoder *encoder);
977 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
979 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
980 uint32_t id, uint32_t type);
982 extern int drm_mode_getresources(struct drm_device *dev,
983 void *data, struct drm_file *file_priv);
984 extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
985 struct drm_file *file_priv);
986 extern int drm_mode_getcrtc(struct drm_device *dev,
987 void *data, struct drm_file *file_priv);
988 extern int drm_mode_getconnector(struct drm_device *dev,
989 void *data, struct drm_file *file_priv);
990 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
991 extern int drm_mode_setcrtc(struct drm_device *dev,
992 void *data, struct drm_file *file_priv);
993 extern int drm_mode_getplane(struct drm_device *dev,
994 void *data, struct drm_file *file_priv);
995 extern int drm_mode_setplane(struct drm_device *dev,
996 void *data, struct drm_file *file_priv);
997 extern int drm_mode_cursor_ioctl(struct drm_device *dev,
998 void *data, struct drm_file *file_priv);
999 extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
1000 void *data, struct drm_file *file_priv);
1001 extern int drm_mode_addfb(struct drm_device *dev,
1002 void *data, struct drm_file *file_priv);
1003 extern int drm_mode_addfb2(struct drm_device *dev,
1004 void *data, struct drm_file *file_priv);
1005 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
1006 extern int drm_mode_rmfb(struct drm_device *dev,
1007 void *data, struct drm_file *file_priv);
1008 extern int drm_mode_getfb(struct drm_device *dev,
1009 void *data, struct drm_file *file_priv);
1010 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1011 void *data, struct drm_file *file_priv);
1013 extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1014 void *data, struct drm_file *file_priv);
1015 extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1016 void *data, struct drm_file *file_priv);
1017 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1018 void *data, struct drm_file *file_priv);
1019 extern int drm_mode_getencoder(struct drm_device *dev,
1020 void *data, struct drm_file *file_priv);
1021 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1022 void *data, struct drm_file *file_priv);
1023 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1024 void *data, struct drm_file *file_priv);
1025 extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
1026 extern enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code);
1027 extern bool drm_detect_hdmi_monitor(struct edid *edid);
1028 extern bool drm_detect_monitor_audio(struct edid *edid);
1029 extern bool drm_rgb_quant_range_selectable(struct edid *edid);
1030 extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1031 void *data, struct drm_file *file_priv);
1032 extern int drm_add_modes_noedid(struct drm_connector *connector,
1033 int hdisplay, int vdisplay);
1034 extern void drm_set_preferred_mode(struct drm_connector *connector,
1035 int hpref, int vpref);
1037 extern int drm_edid_header_is_valid(const u8 *raw_edid);
1038 extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid);
1039 extern bool drm_edid_is_valid(struct edid *edid);
1040 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
1041 int hsize, int vsize, int fresh,
1044 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1045 void *data, struct drm_file *file_priv);
1046 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1047 void *data, struct drm_file *file_priv);
1048 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1049 void *data, struct drm_file *file_priv);
1050 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1051 struct drm_file *file_priv);
1052 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1053 struct drm_file *file_priv);
1055 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1057 extern int drm_format_num_planes(uint32_t format);
1058 extern int drm_format_plane_cpp(uint32_t format, int plane);
1059 extern int drm_format_horz_chroma_subsampling(uint32_t format);
1060 extern int drm_format_vert_chroma_subsampling(uint32_t format);
1061 extern const char *drm_get_format_name(uint32_t format);
1065 static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
1068 struct drm_mode_object *mo;
1069 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE);
1070 return mo ? obj_to_plane(mo) : NULL;
1073 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1076 struct drm_mode_object *mo;
1077 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1078 return mo ? obj_to_crtc(mo) : NULL;
1081 static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
1084 struct drm_mode_object *mo;
1085 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
1086 return mo ? obj_to_encoder(mo) : NULL;
1089 static inline struct drm_connector *drm_connector_find(struct drm_device *dev,
1092 struct drm_mode_object *mo;
1093 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR);
1094 return mo ? obj_to_connector(mo) : NULL;
1097 static inline struct drm_property *drm_property_find(struct drm_device *dev,
1100 struct drm_mode_object *mo;
1101 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY);
1102 return mo ? obj_to_property(mo) : NULL;
1105 static inline struct drm_property_blob *
1106 drm_property_blob_find(struct drm_device *dev, uint32_t id)
1108 struct drm_mode_object *mo;
1109 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_BLOB);
1110 return mo ? obj_to_blob(mo) : NULL;
1113 /* Plane list iterator for legacy (overlay only) planes. */
1114 #define drm_for_each_legacy_plane(plane, planelist) \
1115 list_for_each_entry(plane, planelist, head) \
1116 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1118 #endif /* __DRM_CRTC_H__ */