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 <uapi_drm/drm_mode.h>
35 #include <uapi_drm/drm_fourcc.h>
36 #include <drm/drm_modeset_lock.h>
40 struct drm_framebuffer;
41 struct drm_object_properties;
47 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
48 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
49 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
50 #define DRM_MODE_OBJECT_MODE 0xdededede
51 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
52 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
53 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
54 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
55 #define DRM_MODE_OBJECT_ANY 0
57 struct drm_mode_object {
60 struct drm_object_properties *properties;
63 #define DRM_OBJECT_MAX_PROPERTY 24
64 struct drm_object_properties {
65 int count, atomic_count;
66 /* NOTE: if we ever start dynamically destroying properties (ie.
67 * not at drm_mode_config_cleanup() time), then we'd have to do
68 * a better job of detaching property from mode objects to avoid
69 * dangling property pointers:
71 struct drm_property *properties[DRM_OBJECT_MAX_PROPERTY];
72 /* do not read/write values directly, but use drm_object_property_get_value()
73 * and drm_object_property_set_value():
75 uint64_t values[DRM_OBJECT_MAX_PROPERTY];
78 static inline int64_t U642I64(uint64_t val)
80 return (int64_t)*((int64_t *)&val);
82 static inline uint64_t I642U64(int64_t val)
84 return (uint64_t)*((uint64_t *)&val);
87 /* rotation property bits */
88 #define DRM_ROTATE_MASK 0x0f
89 #define DRM_ROTATE_0 0
90 #define DRM_ROTATE_90 1
91 #define DRM_ROTATE_180 2
92 #define DRM_ROTATE_270 3
93 #define DRM_REFLECT_MASK (~DRM_ROTATE_MASK)
94 #define DRM_REFLECT_X 4
95 #define DRM_REFLECT_Y 5
97 enum drm_connector_force {
98 DRM_FORCE_UNSPECIFIED,
100 DRM_FORCE_ON, /* force on analog part normally */
101 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
104 #include <drm/drm_modes.h>
106 enum drm_connector_status {
107 connector_status_connected = 1,
108 connector_status_disconnected = 2,
109 connector_status_unknown = 3,
112 enum subpixel_order {
114 SubPixelHorizontalRGB,
115 SubPixelHorizontalBGR,
121 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
122 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
123 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
125 * Describes a given display (e.g. CRT or flat panel) and its limitations.
127 struct drm_display_info {
128 char name[DRM_DISPLAY_INFO_LEN];
131 unsigned int width_mm;
132 unsigned int height_mm;
134 /* Clock limits FIXME: storage format */
135 unsigned int min_vfreq, max_vfreq;
136 unsigned int min_hfreq, max_hfreq;
137 unsigned int pixel_clock;
140 enum subpixel_order subpixel_order;
144 unsigned int num_bus_formats;
146 /* Mask of supported hdmi deep color modes */
147 u8 edid_hdmi_dc_modes;
152 /* data corresponds to displayid vend/prod/serial */
153 struct drm_tile_group {
154 struct kref refcount;
155 struct drm_device *dev;
160 struct drm_framebuffer_funcs {
161 /* note: use drm_framebuffer_remove() */
162 void (*destroy)(struct drm_framebuffer *framebuffer);
163 int (*create_handle)(struct drm_framebuffer *fb,
164 struct drm_file *file_priv,
165 unsigned int *handle);
167 * Optional callback for the dirty fb ioctl.
169 * Userspace can notify the driver via this callback
170 * that a area of the framebuffer has changed and should
171 * be flushed to the display hardware.
173 * See documentation in drm_mode.h for the struct
174 * drm_mode_fb_dirty_cmd for more information as all
175 * the semantics and arguments have a one to one mapping
178 int (*dirty)(struct drm_framebuffer *framebuffer,
179 struct drm_file *file_priv, unsigned flags,
180 unsigned color, struct drm_clip_rect *clips,
184 struct drm_framebuffer {
185 struct drm_device *dev;
187 * Note that the fb is refcounted for the benefit of driver internals,
188 * for example some hw, disabling a CRTC/plane is asynchronous, and
189 * scanout does not actually complete until the next vblank. So some
190 * cleanup (like releasing the reference(s) on the backing GEM bo(s))
191 * should be deferred. In cases like this, the driver would like to
192 * hold a ref to the fb even though it has already been removed from
193 * userspace perspective.
195 struct kref refcount;
197 * Place on the dev->mode_config.fb_list, access protected by
198 * dev->mode_config.fb_lock.
200 struct list_head head;
201 struct drm_mode_object base;
202 const struct drm_framebuffer_funcs *funcs;
203 unsigned int pitches[4];
204 unsigned int offsets[4];
205 uint64_t modifier[4];
208 /* depth can be 15 or 16 */
212 uint32_t pixel_format; /* fourcc format */
213 struct list_head filp_head;
216 struct drm_property_blob {
217 struct drm_mode_object base;
218 struct drm_device *dev;
219 struct kref refcount;
220 struct list_head head_global;
221 struct list_head head_file;
223 unsigned char data[];
226 struct drm_property_enum {
228 struct list_head head;
229 char name[DRM_PROP_NAME_LEN];
232 struct drm_property {
233 struct list_head head;
234 struct drm_mode_object base;
236 char name[DRM_PROP_NAME_LEN];
239 struct drm_device *dev;
241 struct list_head enum_list;
245 struct drm_connector;
247 struct drm_pending_vblank_event;
250 struct drm_atomic_state;
253 * struct drm_crtc_state - mutable CRTC state
254 * @crtc: backpointer to the CRTC
255 * @enable: whether the CRTC should be enabled, gates all other state
256 * @active: whether the CRTC is actively displaying (used for DPMS)
257 * @planes_changed: planes on this crtc are updated
258 * @mode_changed: crtc_state->mode or crtc_state->enable has been changed
259 * @active_changed: crtc_state->active has been toggled.
260 * @connectors_changed: connectors to this crtc have been updated
261 * @plane_mask: bitmask of (1 << drm_plane_index(plane)) of attached planes
262 * @last_vblank_count: for helpers and drivers to capture the vblank of the
263 * update to ensure framebuffer cleanup isn't done too early
264 * @adjusted_mode: for use by helpers and drivers to compute adjusted mode timings
265 * @mode: current mode timings
266 * @event: optional pointer to a DRM event to signal upon completion of the
268 * @state: backpointer to global drm_atomic_state
270 * Note that the distinction between @enable and @active is rather subtile:
271 * Flipping @active while @enable is set without changing anything else may
272 * never return in a failure from the ->atomic_check callback. Userspace assumes
273 * that a DPMS On will always succeed. In other words: @enable controls resource
274 * assignment, @active controls the actual hardware state.
276 struct drm_crtc_state {
277 struct drm_crtc *crtc;
282 /* computed state bits used by helpers and drivers */
283 bool planes_changed : 1;
284 bool mode_changed : 1;
285 bool active_changed : 1;
286 bool connectors_changed : 1;
288 /* attached planes bitmask:
289 * WARNING: transitional helpers do not maintain plane_mask so
290 * drivers not converted over to atomic helpers should not rely
291 * on plane_mask being accurate!
295 /* last_vblank_count: for vblank waits before cleanup */
296 u32 last_vblank_count;
298 /* adjusted_mode: for use by helpers and drivers */
299 struct drm_display_mode adjusted_mode;
301 struct drm_display_mode mode;
303 /* blob property to expose current mode to atomic userspace */
304 struct drm_property_blob *mode_blob;
306 struct drm_pending_vblank_event *event;
308 struct drm_atomic_state *state;
312 * struct drm_crtc_funcs - control CRTCs for a given device
313 * @save: save CRTC state
314 * @restore: restore CRTC state
315 * @reset: reset CRTC after state has been invalidated (e.g. resume)
316 * @cursor_set: setup the cursor
317 * @cursor_set2: setup the cursor with hotspot, superseeds @cursor_set if set
318 * @cursor_move: move the cursor
319 * @gamma_set: specify color ramp for CRTC
320 * @destroy: deinit and free object
321 * @set_property: called when a property is changed
322 * @set_config: apply a new CRTC configuration
323 * @page_flip: initiate a page flip
324 * @atomic_duplicate_state: duplicate the atomic state for this CRTC
325 * @atomic_destroy_state: destroy an atomic state for this CRTC
326 * @atomic_set_property: set a property on an atomic state for this CRTC
327 * (do not call directly, use drm_atomic_crtc_set_property())
328 * @atomic_get_property: get a property on an atomic state for this CRTC
329 * (do not call directly, use drm_atomic_crtc_get_property())
331 * The drm_crtc_funcs structure is the central CRTC management structure
332 * in the DRM. Each CRTC controls one or more connectors (note that the name
333 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
334 * connectors, not just CRTs).
336 * Each driver is responsible for filling out this structure at startup time,
337 * in addition to providing other modesetting features, like i2c and DDC
340 struct drm_crtc_funcs {
341 /* Save CRTC state */
342 void (*save)(struct drm_crtc *crtc); /* suspend? */
343 /* Restore CRTC state */
344 void (*restore)(struct drm_crtc *crtc); /* resume? */
345 /* Reset CRTC state */
346 void (*reset)(struct drm_crtc *crtc);
348 /* cursor controls */
349 int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
350 uint32_t handle, uint32_t width, uint32_t height);
351 int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
352 uint32_t handle, uint32_t width, uint32_t height,
353 int32_t hot_x, int32_t hot_y);
354 int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
356 /* Set gamma on the CRTC */
357 void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
358 uint32_t start, uint32_t size);
359 /* Object destroy routine */
360 void (*destroy)(struct drm_crtc *crtc);
362 int (*set_config)(struct drm_mode_set *set);
365 * Flip to the given framebuffer. This implements the page
366 * flip ioctl described in drm_mode.h, specifically, the
367 * implementation must return immediately and block all
368 * rendering to the current fb until the flip has completed.
369 * If userspace set the event flag in the ioctl, the event
370 * argument will point to an event to send back when the flip
371 * completes, otherwise it will be NULL.
373 int (*page_flip)(struct drm_crtc *crtc,
374 struct drm_framebuffer *fb,
375 struct drm_pending_vblank_event *event,
378 int (*set_property)(struct drm_crtc *crtc,
379 struct drm_property *property, uint64_t val);
381 /* atomic update handling */
382 struct drm_crtc_state *(*atomic_duplicate_state)(struct drm_crtc *crtc);
383 void (*atomic_destroy_state)(struct drm_crtc *crtc,
384 struct drm_crtc_state *state);
385 int (*atomic_set_property)(struct drm_crtc *crtc,
386 struct drm_crtc_state *state,
387 struct drm_property *property,
389 int (*atomic_get_property)(struct drm_crtc *crtc,
390 const struct drm_crtc_state *state,
391 struct drm_property *property,
396 * struct drm_crtc - central CRTC control structure
397 * @dev: parent DRM device
398 * @port: OF node used by drm_of_find_possible_crtcs()
399 * @head: list management
400 * @mutex: per-CRTC locking
401 * @base: base KMS object for ID tracking etc.
402 * @primary: primary plane for this CRTC
403 * @cursor: cursor plane for this CRTC
404 * @cursor_x: current x position of the cursor, used for universal cursor planes
405 * @cursor_y: current y position of the cursor, used for universal cursor planes
406 * @enabled: is this CRTC enabled?
407 * @mode: current mode timings
408 * @hwmode: mode timings as programmed to hw regs
409 * @invert_dimensions: for purposes of error checking crtc vs fb sizes,
410 * invert the width/height of the crtc. This is used if the driver
411 * is performing 90 or 270 degree rotated scanout
412 * @x: x position on screen
413 * @y: y position on screen
414 * @funcs: CRTC control functions
415 * @gamma_size: size of gamma ramp
416 * @gamma_store: gamma ramp values
417 * @helper_private: mid-layer private data
418 * @properties: property tracking for this CRTC
419 * @state: current atomic state for this CRTC
420 * @acquire_ctx: per-CRTC implicit acquire context used by atomic drivers for
423 * Each CRTC may have one or more connectors associated with it. This structure
424 * allows the CRTC to be controlled.
427 struct drm_device *dev;
428 struct device_node *port;
429 struct list_head head;
434 * This provides a read lock for the overall crtc state (mode, dpms
435 * state, ...) and a write lock for everything which can be update
436 * without a full modeset (fb, cursor data, ...)
438 struct drm_modeset_lock mutex;
440 struct drm_mode_object base;
442 /* primary and cursor planes for CRTC */
443 struct drm_plane *primary;
444 struct drm_plane *cursor;
446 /* position of cursor plane on crtc */
452 /* Requested mode from modesetting. */
453 struct drm_display_mode mode;
455 /* Programmed mode in hw, after adjustments for encoders,
456 * crtc, panel scaling etc. Needed for timestamping etc.
458 struct drm_display_mode hwmode;
460 bool invert_dimensions;
463 const struct drm_crtc_funcs *funcs;
465 /* CRTC gamma size for reporting to userspace */
467 uint16_t *gamma_store;
469 /* if you are using the helper */
470 const void *helper_private;
472 struct drm_object_properties properties;
474 struct drm_crtc_state *state;
477 * For legacy crtc ioctls so that atomic drivers can get at the locking
480 struct drm_modeset_acquire_ctx *acquire_ctx;
484 * struct drm_connector_state - mutable connector state
485 * @connector: backpointer to the connector
486 * @crtc: CRTC to connect connector to, NULL if disabled
487 * @best_encoder: can be used by helpers and drivers to select the encoder
488 * @state: backpointer to global drm_atomic_state
490 struct drm_connector_state {
491 struct drm_connector *connector;
493 struct drm_crtc *crtc; /* do not write directly, use drm_atomic_set_crtc_for_connector() */
495 struct drm_encoder *best_encoder;
497 struct drm_atomic_state *state;
501 * struct drm_connector_funcs - control connectors on a given device
502 * @dpms: set power state
503 * @save: save connector state
504 * @restore: restore connector state
505 * @reset: reset connector after state has been invalidated (e.g. resume)
506 * @detect: is this connector active?
507 * @fill_modes: fill mode list for this connector
508 * @set_property: property for this connector may need an update
509 * @destroy: make object go away
510 * @force: notify the driver that the connector is forced on
511 * @atomic_duplicate_state: duplicate the atomic state for this connector
512 * @atomic_destroy_state: destroy an atomic state for this connector
513 * @atomic_set_property: set a property on an atomic state for this connector
514 * (do not call directly, use drm_atomic_connector_set_property())
515 * @atomic_get_property: get a property on an atomic state for this connector
516 * (do not call directly, use drm_atomic_connector_get_property())
518 * Each CRTC may have one or more connectors attached to it. The functions
519 * below allow the core DRM code to control connectors, enumerate available modes,
522 struct drm_connector_funcs {
523 int (*dpms)(struct drm_connector *connector, int mode);
524 void (*save)(struct drm_connector *connector);
525 void (*restore)(struct drm_connector *connector);
526 void (*reset)(struct drm_connector *connector);
528 /* Check to see if anything is attached to the connector.
529 * @force is set to false whilst polling, true when checking the
530 * connector due to user request. @force can be used by the driver
531 * to avoid expensive, destructive operations during automated
534 enum drm_connector_status (*detect)(struct drm_connector *connector,
536 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
537 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
539 void (*destroy)(struct drm_connector *connector);
540 void (*force)(struct drm_connector *connector);
542 /* atomic update handling */
543 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
544 void (*atomic_destroy_state)(struct drm_connector *connector,
545 struct drm_connector_state *state);
546 int (*atomic_set_property)(struct drm_connector *connector,
547 struct drm_connector_state *state,
548 struct drm_property *property,
550 int (*atomic_get_property)(struct drm_connector *connector,
551 const struct drm_connector_state *state,
552 struct drm_property *property,
557 * struct drm_encoder_funcs - encoder controls
558 * @reset: reset state (e.g. at init or resume time)
559 * @destroy: cleanup and free associated data
561 * Encoders sit between CRTCs and connectors.
563 struct drm_encoder_funcs {
564 void (*reset)(struct drm_encoder *encoder);
565 void (*destroy)(struct drm_encoder *encoder);
568 #define DRM_CONNECTOR_MAX_ENCODER 3
571 * struct drm_encoder - central DRM encoder structure
572 * @dev: parent DRM device
573 * @head: list management
574 * @base: base KMS object
575 * @name: encoder name
576 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
577 * @possible_crtcs: bitmask of potential CRTC bindings
578 * @possible_clones: bitmask of potential sibling encoders for cloning
579 * @crtc: currently bound CRTC
580 * @bridge: bridge associated to the encoder
581 * @funcs: control functions
582 * @helper_private: mid-layer private data
584 * CRTCs drive pixels to encoders, which convert them into signals
585 * appropriate for a given connector or set of connectors.
588 struct drm_device *dev;
589 struct list_head head;
591 struct drm_mode_object base;
594 uint32_t possible_crtcs;
595 uint32_t possible_clones;
597 struct drm_crtc *crtc;
598 struct drm_bridge *bridge;
599 const struct drm_encoder_funcs *funcs;
600 void *helper_private;
603 /* should we poll this connector for connects and disconnects */
604 /* hot plug detectable */
605 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
606 /* poll for connections */
607 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
608 /* can cleanly poll for disconnections without flickering the screen */
609 /* DACs should rarely do this without a lot of testing */
610 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
612 #define MAX_ELD_BYTES 128
615 * struct drm_connector - central DRM connector control structure
616 * @dev: parent DRM device
617 * @kdev: kernel device for sysfs attributes
618 * @attr: sysfs attributes
619 * @head: list management
620 * @base: base KMS object
621 * @name: connector name
622 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
623 * @connector_type_id: index into connector type enum
624 * @interlace_allowed: can this connector handle interlaced modes?
625 * @doublescan_allowed: can this connector handle doublescan?
626 * @stereo_allowed: can this connector handle stereo modes?
627 * @modes: modes available on this connector (from fill_modes() + user)
628 * @status: one of the drm_connector_status enums (connected, not, or unknown)
629 * @probed_modes: list of modes derived directly from the display
630 * @display_info: information about attached display (e.g. from EDID)
631 * @funcs: connector control functions
632 * @edid_blob_ptr: DRM property containing EDID if present
633 * @properties: property tracking for this connector
634 * @path_blob_ptr: DRM blob property data for the DP MST path property
635 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
636 * @dpms: current dpms state
637 * @helper_private: mid-layer private data
638 * @cmdline_mode: mode line parsed from the kernel cmdline for this connector
639 * @force: a %DRM_FORCE_<foo> state for forced mode sets
640 * @override_edid: has the EDID been overwritten through debugfs for testing?
641 * @encoder_ids: valid encoders for this connector
642 * @encoder: encoder driving this connector, if any
643 * @eld: EDID-like data, if present
644 * @dvi_dual: dual link DVI, if found
645 * @max_tmds_clock: max clock rate, if found
646 * @latency_present: AV delay info from ELD, if found
647 * @video_latency: video latency info from ELD, if found
648 * @audio_latency: audio latency info from ELD, if found
649 * @null_edid_counter: track sinks that give us all zeros for the EDID
650 * @bad_edid_counter: track sinks that give us an EDID with invalid checksum
651 * @edid_corrupt: indicates whether the last read EDID was corrupt
652 * @debugfs_entry: debugfs directory for this connector
653 * @state: current atomic state for this connector
654 * @has_tile: is this connector connected to a tiled monitor
655 * @tile_group: tile group for the connected monitor
656 * @tile_is_single_monitor: whether the tile is one monitor housing
657 * @num_h_tile: number of horizontal tiles in the tile group
658 * @num_v_tile: number of vertical tiles in the tile group
659 * @tile_h_loc: horizontal location of this tile
660 * @tile_v_loc: vertical location of this tile
661 * @tile_h_size: horizontal size of this tile.
662 * @tile_v_size: vertical size of this tile.
664 * Each connector may be connected to one or more CRTCs, or may be clonable by
665 * another connector if they can share a CRTC. Each connector also has a specific
666 * position in the broader display (referred to as a 'screen' though it could
667 * span multiple monitors).
669 struct drm_connector {
670 struct drm_device *dev;
672 struct device_attribute *attr;
673 struct list_head head;
675 struct drm_mode_object base;
679 int connector_type_id;
680 bool interlace_allowed;
681 bool doublescan_allowed;
683 struct list_head modes; /* list of modes on this connector */
685 enum drm_connector_status status;
687 /* these are modes added by probing with DDC or the BIOS */
688 struct list_head probed_modes;
690 struct drm_display_info display_info;
691 const struct drm_connector_funcs *funcs;
693 struct drm_property_blob *edid_blob_ptr;
694 struct drm_object_properties properties;
696 struct drm_property_blob *path_blob_ptr;
698 struct drm_property_blob *tile_blob_ptr;
700 uint8_t polled; /* DRM_CONNECTOR_POLL_* */
702 /* requested DPMS state */
705 void *helper_private;
707 /* forced on connector */
708 struct drm_cmdline_mode cmdline_mode;
709 enum drm_connector_force force;
711 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
712 struct drm_encoder *encoder; /* currently active encoder */
715 uint8_t eld[MAX_ELD_BYTES];
717 int max_tmds_clock; /* in MHz */
718 bool latency_present[2];
719 int video_latency[2]; /* [0]: progressive, [1]: interlaced */
720 int audio_latency[2];
721 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
722 unsigned bad_edid_counter;
724 /* Flag for raw EDID header corruption - used in Displayport
725 * compliance testing - * Displayport Link CTS Core 1.2 rev1.1 4.2.2.6
729 struct dentry *debugfs_entry;
731 struct drm_connector_state *state;
735 struct drm_tile_group *tile_group;
736 bool tile_is_single_monitor;
738 uint8_t num_h_tile, num_v_tile;
739 uint8_t tile_h_loc, tile_v_loc;
740 uint16_t tile_h_size, tile_v_size;
744 * struct drm_plane_state - mutable plane state
745 * @plane: backpointer to the plane
746 * @crtc: currently bound CRTC, NULL if disabled
747 * @fb: currently bound framebuffer
748 * @fence: optional fence to wait for before scanning out @fb
749 * @crtc_x: left position of visible portion of plane on crtc
750 * @crtc_y: upper position of visible portion of plane on crtc
751 * @crtc_w: width of visible portion of plane on crtc
752 * @crtc_h: height of visible portion of plane on crtc
753 * @src_x: left position of visible portion of plane within
755 * @src_y: upper position of visible portion of plane within
757 * @src_w: width of visible portion of plane (in 16.16)
758 * @src_h: height of visible portion of plane (in 16.16)
759 * @state: backpointer to global drm_atomic_state
761 struct drm_plane_state {
762 struct drm_plane *plane;
764 struct drm_crtc *crtc; /* do not write directly, use drm_atomic_set_crtc_for_plane() */
765 struct drm_framebuffer *fb; /* do not write directly, use drm_atomic_set_fb_for_plane() */
766 /* XXX: implement linux/fence.h first */
767 /* struct fence *fence; */
769 /* Signed dest location allows it to be partially off screen */
770 int32_t crtc_x, crtc_y;
771 uint32_t crtc_w, crtc_h;
773 /* Source values are 16.16 fixed point */
774 uint32_t src_x, src_y;
775 uint32_t src_h, src_w;
778 unsigned int rotation;
780 struct drm_atomic_state *state;
785 * struct drm_plane_funcs - driver plane control functions
786 * @update_plane: update the plane configuration
787 * @disable_plane: shut down the plane
788 * @destroy: clean up plane resources
789 * @reset: reset plane after state has been invalidated (e.g. resume)
790 * @set_property: called when a property is changed
791 * @atomic_duplicate_state: duplicate the atomic state for this plane
792 * @atomic_destroy_state: destroy an atomic state for this plane
793 * @atomic_set_property: set a property on an atomic state for this plane
794 * (do not call directly, use drm_atomic_plane_set_property())
795 * @atomic_get_property: get a property on an atomic state for this plane
796 * (do not call directly, use drm_atomic_plane_get_property())
798 struct drm_plane_funcs {
799 int (*update_plane)(struct drm_plane *plane,
800 struct drm_crtc *crtc, struct drm_framebuffer *fb,
801 int crtc_x, int crtc_y,
802 unsigned int crtc_w, unsigned int crtc_h,
803 uint32_t src_x, uint32_t src_y,
804 uint32_t src_w, uint32_t src_h);
805 int (*disable_plane)(struct drm_plane *plane);
806 void (*destroy)(struct drm_plane *plane);
807 void (*reset)(struct drm_plane *plane);
809 int (*set_property)(struct drm_plane *plane,
810 struct drm_property *property, uint64_t val);
812 /* atomic update handling */
813 struct drm_plane_state *(*atomic_duplicate_state)(struct drm_plane *plane);
814 void (*atomic_destroy_state)(struct drm_plane *plane,
815 struct drm_plane_state *state);
816 int (*atomic_set_property)(struct drm_plane *plane,
817 struct drm_plane_state *state,
818 struct drm_property *property,
820 int (*atomic_get_property)(struct drm_plane *plane,
821 const struct drm_plane_state *state,
822 struct drm_property *property,
826 enum drm_plane_type {
827 DRM_PLANE_TYPE_OVERLAY,
828 DRM_PLANE_TYPE_PRIMARY,
829 DRM_PLANE_TYPE_CURSOR,
833 * struct drm_plane - central DRM plane control structure
834 * @dev: DRM device this plane belongs to
835 * @head: for list management
836 * @base: base mode object
837 * @possible_crtcs: pipes this plane can be bound to
838 * @format_types: array of formats supported by this plane
839 * @format_count: number of formats supported
840 * @format_default: driver hasn't supplied supported formats for the plane
841 * @crtc: currently bound CRTC
842 * @fb: currently bound fb
843 * @old_fb: Temporary tracking of the old fb while a modeset is ongoing. Used by
844 * drm_mode_set_config_internal() to implement correct refcounting.
845 * @funcs: helper functions
846 * @properties: property tracking for this plane
847 * @type: type of plane (overlay, primary, cursor)
848 * @state: current atomic state for this plane
851 struct drm_device *dev;
852 struct list_head head;
854 struct drm_modeset_lock mutex;
856 struct drm_mode_object base;
858 uint32_t possible_crtcs;
859 uint32_t *format_types;
860 unsigned int format_count;
863 struct drm_crtc *crtc;
864 struct drm_framebuffer *fb;
866 struct drm_framebuffer *old_fb;
868 const struct drm_plane_funcs *funcs;
870 struct drm_object_properties properties;
872 enum drm_plane_type type;
874 const void *helper_private;
876 struct drm_plane_state *state;
880 * struct drm_bridge_funcs - drm_bridge control functions
881 * @attach: Called during drm_bridge_attach
882 * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
883 * @disable: Called right before encoder prepare, disables the bridge
884 * @post_disable: Called right after encoder prepare, for lockstepped disable
885 * @mode_set: Set this mode to the bridge
886 * @pre_enable: Called right before encoder commit, for lockstepped commit
887 * @enable: Called right after encoder commit, enables the bridge
889 struct drm_bridge_funcs {
890 int (*attach)(struct drm_bridge *bridge);
891 bool (*mode_fixup)(struct drm_bridge *bridge,
892 const struct drm_display_mode *mode,
893 struct drm_display_mode *adjusted_mode);
894 void (*disable)(struct drm_bridge *bridge);
895 void (*post_disable)(struct drm_bridge *bridge);
896 void (*mode_set)(struct drm_bridge *bridge,
897 struct drm_display_mode *mode,
898 struct drm_display_mode *adjusted_mode);
899 void (*pre_enable)(struct drm_bridge *bridge);
900 void (*enable)(struct drm_bridge *bridge);
904 * struct drm_bridge - central DRM bridge control structure
905 * @dev: DRM device this bridge belongs to
906 * @encoder: encoder to which this bridge is connected
907 * @next: the next bridge in the encoder chain
908 * @of_node: device node pointer to the bridge
909 * @list: to keep track of all added bridges
910 * @funcs: control functions
911 * @driver_private: pointer to the bridge driver's internal context
914 struct drm_device *dev;
915 struct drm_encoder *encoder;
916 struct drm_bridge *next;
918 struct device_node *of_node;
920 struct list_head list;
922 const struct drm_bridge_funcs *funcs;
923 void *driver_private;
927 * struct drm_atomic_state - the global state object for atomic updates
928 * @dev: parent DRM device
929 * @allow_modeset: allow full modeset
930 * @legacy_cursor_update: hint to enforce legacy cursor ioctl semantics
931 * @planes: pointer to array of plane pointers
932 * @plane_states: pointer to array of plane states pointers
933 * @crtcs: pointer to array of CRTC pointers
934 * @crtc_states: pointer to array of CRTC states pointers
935 * @num_connector: size of the @connectors and @connector_states arrays
936 * @connectors: pointer to array of connector pointers
937 * @connector_states: pointer to array of connector states pointers
938 * @acquire_ctx: acquire context for this atomic modeset state update
940 struct drm_atomic_state {
941 struct drm_device *dev;
942 bool allow_modeset : 1;
943 bool legacy_cursor_update : 1;
944 struct drm_plane **planes;
945 struct drm_plane_state **plane_states;
946 struct drm_crtc **crtcs;
947 struct drm_crtc_state **crtc_states;
949 struct drm_connector **connectors;
950 struct drm_connector_state **connector_states;
952 struct drm_modeset_acquire_ctx *acquire_ctx;
957 * struct drm_mode_set - new values for a CRTC config change
958 * @fb: framebuffer to use for new config
959 * @crtc: CRTC whose configuration we're about to change
960 * @mode: mode timings to use
961 * @x: position of this CRTC relative to @fb
962 * @y: position of this CRTC relative to @fb
963 * @connectors: array of connectors to drive with this CRTC if possible
964 * @num_connectors: size of @connectors array
966 * Represents a single crtc the connectors that it drives with what mode
967 * and from which framebuffer it scans out from.
969 * This is used to set modes.
971 struct drm_mode_set {
972 struct drm_framebuffer *fb;
973 struct drm_crtc *crtc;
974 struct drm_display_mode *mode;
979 struct drm_connector **connectors;
980 size_t num_connectors;
984 * struct drm_mode_config_funcs - basic driver provided mode setting functions
985 * @fb_create: create a new framebuffer object
986 * @output_poll_changed: function to handle output configuration changes
987 * @atomic_check: check whether a given atomic state update is possible
988 * @atomic_commit: commit an atomic state update previously verified with
990 * @atomic_state_alloc: allocate a new atomic state
991 * @atomic_state_clear: clear the atomic state
992 * @atomic_state_free: free the atomic state
994 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
997 struct drm_mode_config_funcs {
998 struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
999 struct drm_file *file_priv,
1000 struct drm_mode_fb_cmd2 *mode_cmd);
1001 void (*output_poll_changed)(struct drm_device *dev);
1003 int (*atomic_check)(struct drm_device *dev,
1004 struct drm_atomic_state *a);
1005 int (*atomic_commit)(struct drm_device *dev,
1006 struct drm_atomic_state *a,
1008 struct drm_atomic_state *(*atomic_state_alloc)(struct drm_device *dev);
1009 void (*atomic_state_clear)(struct drm_atomic_state *state);
1010 void (*atomic_state_free)(struct drm_atomic_state *state);
1014 * struct drm_mode_config - Mode configuration control structure
1015 * @mutex: mutex protecting KMS related lists and structures
1016 * @connection_mutex: ww mutex protecting connector state and routing
1017 * @acquire_ctx: global implicit acquire context used by atomic drivers for
1019 * @idr_mutex: mutex for KMS ID allocation and management
1020 * @crtc_idr: main KMS ID tracking object
1021 * @fb_lock: mutex to protect fb state and lists
1022 * @num_fb: number of fbs available
1023 * @fb_list: list of framebuffers available
1024 * @num_connector: number of connectors on this device
1025 * @connector_list: list of connector objects
1026 * @num_encoder: number of encoders on this device
1027 * @encoder_list: list of encoder objects
1028 * @num_overlay_plane: number of overlay planes on this device
1029 * @num_total_plane: number of universal (i.e. with primary/curso) planes on this device
1030 * @plane_list: list of plane objects
1031 * @num_crtc: number of CRTCs on this device
1032 * @crtc_list: list of CRTC objects
1033 * @property_list: list of property objects
1034 * @min_width: minimum pixel width on this device
1035 * @min_height: minimum pixel height on this device
1036 * @max_width: maximum pixel width on this device
1037 * @max_height: maximum pixel height on this device
1038 * @funcs: core driver provided mode setting functions
1039 * @fb_base: base address of the framebuffer
1040 * @poll_enabled: track polling support for this device
1041 * @poll_running: track polling status for this device
1042 * @output_poll_work: delayed work for polling in process context
1043 * @property_blob_list: list of all the blob property objects
1044 * @blob_lock: mutex for blob property allocation and management
1045 * @*_property: core property tracking
1046 * @preferred_depth: preferred RBG pixel depth, used by fb helpers
1047 * @prefer_shadow: hint to userspace to prefer shadow-fb rendering
1048 * @async_page_flip: does this device support async flips on the primary plane?
1049 * @cursor_width: hint to userspace for max cursor width
1050 * @cursor_height: hint to userspace for max cursor height
1052 * Core mode resource tracking structure. All CRTC, encoders, and connectors
1053 * enumerated by the driver are added here, as are global properties. Some
1054 * global restrictions are also here, e.g. dimension restrictions.
1056 struct drm_mode_config {
1057 struct lock mutex; /* protects configuration (mode lists etc.) */
1058 struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */
1059 struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */
1060 struct lock idr_mutex; /* for IDR management */
1061 struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
1062 struct idr tile_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
1063 /* this is limited to one for now */
1065 struct lock fb_lock; /* proctects global and per-file fb lists */
1067 struct list_head fb_list;
1070 struct list_head connector_list;
1072 struct list_head encoder_list;
1075 * Track # of overlay planes separately from # of total planes. By
1076 * default we only advertise overlay planes to userspace; if userspace
1077 * sets the "universal plane" capability bit, we'll go ahead and
1078 * expose all planes.
1080 int num_overlay_plane;
1081 int num_total_plane;
1082 struct list_head plane_list;
1085 struct list_head crtc_list;
1087 struct list_head property_list;
1089 int min_width, min_height;
1090 int max_width, max_height;
1091 const struct drm_mode_config_funcs *funcs;
1092 resource_size_t fb_base;
1094 /* output poll support */
1098 struct delayed_work output_poll_work;
1100 struct lock blob_lock;
1102 /* pointers to standard properties */
1103 struct list_head property_blob_list;
1104 struct drm_property *edid_property;
1105 struct drm_property *dpms_property;
1106 struct drm_property *path_property;
1107 struct drm_property *tile_property;
1108 struct drm_property *plane_type_property;
1109 struct drm_property *rotation_property;
1110 struct drm_property *prop_src_x;
1111 struct drm_property *prop_src_y;
1112 struct drm_property *prop_src_w;
1113 struct drm_property *prop_src_h;
1114 struct drm_property *prop_crtc_x;
1115 struct drm_property *prop_crtc_y;
1116 struct drm_property *prop_crtc_w;
1117 struct drm_property *prop_crtc_h;
1118 struct drm_property *prop_fb_id;
1119 struct drm_property *prop_crtc_id;
1120 struct drm_property *prop_active;
1121 struct drm_property *prop_mode_id;
1123 /* DVI-I properties */
1124 struct drm_property *dvi_i_subconnector_property;
1125 struct drm_property *dvi_i_select_subconnector_property;
1128 struct drm_property *tv_subconnector_property;
1129 struct drm_property *tv_select_subconnector_property;
1130 struct drm_property *tv_mode_property;
1131 struct drm_property *tv_left_margin_property;
1132 struct drm_property *tv_right_margin_property;
1133 struct drm_property *tv_top_margin_property;
1134 struct drm_property *tv_bottom_margin_property;
1135 struct drm_property *tv_brightness_property;
1136 struct drm_property *tv_contrast_property;
1137 struct drm_property *tv_flicker_reduction_property;
1138 struct drm_property *tv_overscan_property;
1139 struct drm_property *tv_saturation_property;
1140 struct drm_property *tv_hue_property;
1142 /* Optional properties */
1143 struct drm_property *scaling_mode_property;
1144 struct drm_property *aspect_ratio_property;
1145 struct drm_property *dirty_info_property;
1147 /* properties for virtual machine layout */
1148 struct drm_property *suggested_x_property;
1149 struct drm_property *suggested_y_property;
1151 /* dumb ioctl parameters */
1152 uint32_t preferred_depth, prefer_shadow;
1154 /* whether async page flip is supported or not */
1155 bool async_page_flip;
1157 /* whether the driver supports fb modifiers */
1158 bool allow_fb_modifiers;
1161 uint32_t cursor_width, cursor_height;
1165 * drm_for_each_plane_mask - iterate over planes specified by bitmask
1166 * @plane: the loop cursor
1167 * @dev: the DRM device
1168 * @plane_mask: bitmask of plane indices
1170 * Iterate over all planes specified by bitmask.
1172 #define drm_for_each_plane_mask(plane, dev, plane_mask) \
1173 list_for_each_entry((plane), &(dev)->mode_config.plane_list, head) \
1174 if ((plane_mask) & (1 << drm_plane_index(plane)))
1177 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
1178 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
1179 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
1180 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
1181 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
1182 #define obj_to_property(x) container_of(x, struct drm_property, base)
1183 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
1184 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
1186 struct drm_prop_enum_list {
1191 extern int drm_crtc_init_with_planes(struct drm_device *dev,
1192 struct drm_crtc *crtc,
1193 struct drm_plane *primary,
1194 struct drm_plane *cursor,
1195 const struct drm_crtc_funcs *funcs);
1196 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
1197 extern unsigned int drm_crtc_index(struct drm_crtc *crtc);
1200 * drm_crtc_mask - find the mask of a registered CRTC
1201 * @crtc: CRTC to find mask for
1203 * Given a registered CRTC, return the mask bit of that CRTC for an
1204 * encoder's possible_crtcs field.
1206 static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
1208 return 1 << drm_crtc_index(crtc);
1211 extern void drm_connector_ida_init(void);
1212 extern void drm_connector_ida_destroy(void);
1213 extern int drm_connector_init(struct drm_device *dev,
1214 struct drm_connector *connector,
1215 const struct drm_connector_funcs *funcs,
1216 int connector_type);
1217 int drm_connector_register(struct drm_connector *connector);
1218 void drm_connector_unregister(struct drm_connector *connector);
1220 extern void drm_connector_cleanup(struct drm_connector *connector);
1221 extern unsigned int drm_connector_index(struct drm_connector *connector);
1222 /* helper to unplug all connectors from sysfs for device */
1223 extern void drm_connector_unplug_all(struct drm_device *dev);
1225 extern int drm_bridge_add(struct drm_bridge *bridge);
1226 extern void drm_bridge_remove(struct drm_bridge *bridge);
1227 extern struct drm_bridge *of_drm_find_bridge(struct device_node *np);
1228 extern int drm_bridge_attach(struct drm_device *dev, struct drm_bridge *bridge);
1230 bool drm_bridge_mode_fixup(struct drm_bridge *bridge,
1231 const struct drm_display_mode *mode,
1232 struct drm_display_mode *adjusted_mode);
1233 void drm_bridge_disable(struct drm_bridge *bridge);
1234 void drm_bridge_post_disable(struct drm_bridge *bridge);
1235 void drm_bridge_mode_set(struct drm_bridge *bridge,
1236 struct drm_display_mode *mode,
1237 struct drm_display_mode *adjusted_mode);
1238 void drm_bridge_pre_enable(struct drm_bridge *bridge);
1239 void drm_bridge_enable(struct drm_bridge *bridge);
1241 extern int drm_encoder_init(struct drm_device *dev,
1242 struct drm_encoder *encoder,
1243 const struct drm_encoder_funcs *funcs,
1247 * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
1248 * @encoder: encoder to test
1249 * @crtc: crtc to test
1251 * Return false if @encoder can't be driven by @crtc, true otherwise.
1253 static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
1254 struct drm_crtc *crtc)
1256 return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
1259 extern int drm_universal_plane_init(struct drm_device *dev,
1260 struct drm_plane *plane,
1261 unsigned long possible_crtcs,
1262 const struct drm_plane_funcs *funcs,
1263 const uint32_t *formats,
1264 unsigned int format_count,
1265 enum drm_plane_type type);
1266 extern int drm_plane_init(struct drm_device *dev,
1267 struct drm_plane *plane,
1268 unsigned long possible_crtcs,
1269 const struct drm_plane_funcs *funcs,
1270 const uint32_t *formats, unsigned int format_count,
1272 extern void drm_plane_cleanup(struct drm_plane *plane);
1273 extern unsigned int drm_plane_index(struct drm_plane *plane);
1274 extern struct drm_plane * drm_plane_from_index(struct drm_device *dev, int idx);
1275 extern void drm_plane_force_disable(struct drm_plane *plane);
1276 extern int drm_plane_check_pixel_format(const struct drm_plane *plane,
1278 extern void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
1279 int *hdisplay, int *vdisplay);
1280 extern int drm_crtc_check_viewport(const struct drm_crtc *crtc,
1282 const struct drm_display_mode *mode,
1283 const struct drm_framebuffer *fb);
1285 extern void drm_encoder_cleanup(struct drm_encoder *encoder);
1287 extern const char *drm_get_connector_status_name(enum drm_connector_status status);
1288 extern const char *drm_get_subpixel_order_name(enum subpixel_order order);
1289 extern const char *drm_get_dpms_name(int val);
1290 extern const char *drm_get_dvi_i_subconnector_name(int val);
1291 extern const char *drm_get_dvi_i_select_name(int val);
1292 extern const char *drm_get_tv_subconnector_name(int val);
1293 extern const char *drm_get_tv_select_name(int val);
1294 extern void drm_fb_release(struct drm_file *file_priv);
1295 extern void drm_property_destroy_user_blobs(struct drm_device *dev,
1296 struct drm_file *file_priv);
1297 extern bool drm_probe_ddc(struct i2c_adapter *adapter);
1298 extern struct edid *drm_get_edid(struct drm_connector *connector,
1299 struct i2c_adapter *adapter);
1300 extern struct edid *drm_edid_duplicate(const struct edid *edid);
1301 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
1302 extern void drm_mode_config_init(struct drm_device *dev);
1303 extern void drm_mode_config_reset(struct drm_device *dev);
1304 extern void drm_mode_config_cleanup(struct drm_device *dev);
1306 extern int drm_mode_connector_set_path_property(struct drm_connector *connector,
1308 int drm_mode_connector_set_tile_property(struct drm_connector *connector);
1309 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
1310 const struct edid *edid);
1312 extern int drm_display_info_set_bus_formats(struct drm_display_info *info,
1314 unsigned int num_formats);
1316 static inline bool drm_property_type_is(struct drm_property *property,
1319 /* instanceof for props.. handles extended type vs original types: */
1320 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
1321 return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;
1322 return property->flags & type;
1325 static inline bool drm_property_type_valid(struct drm_property *property)
1327 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
1328 return !(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
1329 return !!(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
1332 extern int drm_object_property_set_value(struct drm_mode_object *obj,
1333 struct drm_property *property,
1335 extern int drm_object_property_get_value(struct drm_mode_object *obj,
1336 struct drm_property *property,
1338 extern int drm_framebuffer_init(struct drm_device *dev,
1339 struct drm_framebuffer *fb,
1340 const struct drm_framebuffer_funcs *funcs);
1341 extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
1343 extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
1344 extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
1345 extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
1346 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
1347 extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
1349 extern void drm_object_attach_property(struct drm_mode_object *obj,
1350 struct drm_property *property,
1352 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
1353 const char *name, int num_values);
1354 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
1356 const struct drm_prop_enum_list *props,
1358 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
1359 int flags, const char *name,
1360 const struct drm_prop_enum_list *props,
1362 uint64_t supported_bits);
1363 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
1365 uint64_t min, uint64_t max);
1366 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
1367 int flags, const char *name,
1368 int64_t min, int64_t max);
1369 struct drm_property *drm_property_create_object(struct drm_device *dev,
1370 int flags, const char *name, uint32_t type);
1371 struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags,
1373 struct drm_property_blob *drm_property_create_blob(struct drm_device *dev,
1376 struct drm_property_blob *drm_property_lookup_blob(struct drm_device *dev,
1378 struct drm_property_blob *drm_property_reference_blob(struct drm_property_blob *blob);
1379 void drm_property_unreference_blob(struct drm_property_blob *blob);
1380 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
1381 extern int drm_property_add_enum(struct drm_property *property, int index,
1382 uint64_t value, const char *name);
1383 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1384 extern int drm_mode_create_tv_properties(struct drm_device *dev,
1385 unsigned int num_modes,
1386 const char * const modes[]);
1387 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1388 extern int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1389 extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
1390 extern int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
1391 extern bool drm_property_change_valid_get(struct drm_property *property,
1392 uint64_t value, struct drm_mode_object **ref);
1393 extern void drm_property_change_valid_put(struct drm_property *property,
1394 struct drm_mode_object *ref);
1396 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
1397 struct drm_encoder *encoder);
1398 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
1400 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
1401 uint32_t id, uint32_t type);
1404 extern int drm_mode_getresources(struct drm_device *dev,
1405 void *data, struct drm_file *file_priv);
1406 extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
1407 struct drm_file *file_priv);
1408 extern int drm_mode_getcrtc(struct drm_device *dev,
1409 void *data, struct drm_file *file_priv);
1410 extern int drm_mode_getconnector(struct drm_device *dev,
1411 void *data, struct drm_file *file_priv);
1412 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
1413 extern int drm_mode_setcrtc(struct drm_device *dev,
1414 void *data, struct drm_file *file_priv);
1415 extern int drm_mode_getplane(struct drm_device *dev,
1416 void *data, struct drm_file *file_priv);
1417 extern int drm_mode_setplane(struct drm_device *dev,
1418 void *data, struct drm_file *file_priv);
1419 extern int drm_mode_cursor_ioctl(struct drm_device *dev,
1420 void *data, struct drm_file *file_priv);
1421 extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
1422 void *data, struct drm_file *file_priv);
1423 extern int drm_mode_addfb(struct drm_device *dev,
1424 void *data, struct drm_file *file_priv);
1425 extern int drm_mode_addfb2(struct drm_device *dev,
1426 void *data, struct drm_file *file_priv);
1427 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
1428 extern int drm_mode_rmfb(struct drm_device *dev,
1429 void *data, struct drm_file *file_priv);
1430 extern int drm_mode_getfb(struct drm_device *dev,
1431 void *data, struct drm_file *file_priv);
1432 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1433 void *data, struct drm_file *file_priv);
1435 extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1436 void *data, struct drm_file *file_priv);
1437 extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1438 void *data, struct drm_file *file_priv);
1439 extern int drm_mode_createblob_ioctl(struct drm_device *dev,
1440 void *data, struct drm_file *file_priv);
1441 extern int drm_mode_destroyblob_ioctl(struct drm_device *dev,
1442 void *data, struct drm_file *file_priv);
1443 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1444 void *data, struct drm_file *file_priv);
1445 extern int drm_mode_getencoder(struct drm_device *dev,
1446 void *data, struct drm_file *file_priv);
1447 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1448 void *data, struct drm_file *file_priv);
1449 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1450 void *data, struct drm_file *file_priv);
1451 extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
1452 extern enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code);
1453 extern bool drm_detect_hdmi_monitor(struct edid *edid);
1454 extern bool drm_detect_monitor_audio(struct edid *edid);
1455 extern bool drm_rgb_quant_range_selectable(struct edid *edid);
1456 extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1457 void *data, struct drm_file *file_priv);
1458 extern int drm_add_modes_noedid(struct drm_connector *connector,
1459 int hdisplay, int vdisplay);
1460 extern void drm_set_preferred_mode(struct drm_connector *connector,
1461 int hpref, int vpref);
1463 extern int drm_edid_header_is_valid(const u8 *raw_edid);
1464 extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid,
1465 bool *edid_corrupt);
1466 extern bool drm_edid_is_valid(struct edid *edid);
1468 extern struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1470 extern struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1472 extern void drm_mode_put_tile_group(struct drm_device *dev,
1473 struct drm_tile_group *tg);
1474 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
1475 int hsize, int vsize, int fresh,
1478 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1479 void *data, struct drm_file *file_priv);
1480 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1481 void *data, struct drm_file *file_priv);
1482 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1483 void *data, struct drm_file *file_priv);
1484 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1485 struct drm_file *file_priv);
1486 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1487 struct drm_file *file_priv);
1488 extern int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
1489 struct drm_property *property,
1492 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1494 extern int drm_format_num_planes(uint32_t format);
1495 extern int drm_format_plane_cpp(uint32_t format, int plane);
1496 extern int drm_format_horz_chroma_subsampling(uint32_t format);
1497 extern int drm_format_vert_chroma_subsampling(uint32_t format);
1498 extern const char *drm_get_format_name(uint32_t format);
1499 extern struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
1500 unsigned int supported_rotations);
1501 extern unsigned int drm_rotation_simplify(unsigned int rotation,
1502 unsigned int supported_rotations);
1506 static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
1509 struct drm_mode_object *mo;
1510 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE);
1511 return mo ? obj_to_plane(mo) : NULL;
1514 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1517 struct drm_mode_object *mo;
1518 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1519 return mo ? obj_to_crtc(mo) : NULL;
1522 static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
1525 struct drm_mode_object *mo;
1526 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
1527 return mo ? obj_to_encoder(mo) : NULL;
1530 static inline struct drm_connector *drm_connector_find(struct drm_device *dev,
1533 struct drm_mode_object *mo;
1534 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR);
1535 return mo ? obj_to_connector(mo) : NULL;
1538 static inline struct drm_property *drm_property_find(struct drm_device *dev,
1541 struct drm_mode_object *mo;
1542 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY);
1543 return mo ? obj_to_property(mo) : NULL;
1546 /* Plane list iterator for legacy (overlay only) planes. */
1547 #define drm_for_each_legacy_plane(plane, dev) \
1548 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) \
1549 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1551 #define drm_for_each_plane(plane, dev) \
1552 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head)
1554 #define drm_for_each_crtc(crtc, dev) \
1555 list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)
1558 assert_drm_connector_list_read_locked(struct drm_mode_config *mode_config)
1561 * The connector hotadd/remove code currently grabs both locks when
1562 * updating lists. Hence readers need only hold either of them to be
1563 * safe and the check amounts to
1565 * WARN_ON(not_holding(A) && not_holding(B)).
1567 WARN_ON(!mutex_is_locked(&mode_config->mutex) &&
1568 !drm_modeset_is_locked(&mode_config->connection_mutex));
1571 #define drm_for_each_connector(connector, dev) \
1572 for (assert_drm_connector_list_read_locked(&(dev)->mode_config), \
1573 connector = list_first_entry(&(dev)->mode_config.connector_list, \
1574 struct drm_connector, head); \
1575 &connector->head != (&(dev)->mode_config.connector_list); \
1576 connector = list_next_entry(connector, head))
1578 #define drm_for_each_encoder(encoder, dev) \
1579 list_for_each_entry(encoder, &(dev)->mode_config.encoder_list, head)
1581 #define drm_for_each_fb(fb, dev) \
1582 for (WARN_ON(!mutex_is_locked(&(dev)->mode_config.fb_lock)), \
1583 fb = list_first_entry(&(dev)->mode_config.fb_list, \
1584 struct drm_framebuffer, head); \
1585 &fb->head != (&(dev)->mode_config.fb_list); \
1586 fb = list_next_entry(fb, head))
1588 #endif /* __DRM_CRTC_H__ */