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 <linux/media-bus-format.h>
35 #include <uapi/drm/drm_mode.h>
36 #include <uapi/drm/drm_fourcc.h>
37 #include <drm/drm_modeset_lock.h>
41 struct drm_framebuffer;
42 struct drm_object_properties;
48 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
49 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
50 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
51 #define DRM_MODE_OBJECT_MODE 0xdededede
52 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
53 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
54 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
55 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
56 #define DRM_MODE_OBJECT_ANY 0
58 struct drm_mode_object {
61 struct drm_object_properties *properties;
64 #define DRM_OBJECT_MAX_PROPERTY 24
65 struct drm_object_properties {
66 int count, atomic_count;
67 /* NOTE: if we ever start dynamically destroying properties (ie.
68 * not at drm_mode_config_cleanup() time), then we'd have to do
69 * a better job of detaching property from mode objects to avoid
70 * dangling property pointers:
72 struct drm_property *properties[DRM_OBJECT_MAX_PROPERTY];
73 /* do not read/write values directly, but use drm_object_property_get_value()
74 * and drm_object_property_set_value():
76 uint64_t values[DRM_OBJECT_MAX_PROPERTY];
79 static inline int64_t U642I64(uint64_t val)
81 return (int64_t)*((int64_t *)&val);
83 static inline uint64_t I642U64(int64_t val)
85 return (uint64_t)*((uint64_t *)&val);
88 /* rotation property bits */
89 #define DRM_ROTATE_MASK 0x0f
90 #define DRM_ROTATE_0 0
91 #define DRM_ROTATE_90 1
92 #define DRM_ROTATE_180 2
93 #define DRM_ROTATE_270 3
94 #define DRM_REFLECT_MASK (~DRM_ROTATE_MASK)
95 #define DRM_REFLECT_X 4
96 #define DRM_REFLECT_Y 5
98 enum drm_connector_force {
99 DRM_FORCE_UNSPECIFIED,
101 DRM_FORCE_ON, /* force on analog part normally */
102 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
105 #include <drm/drm_modes.h>
107 enum drm_connector_status {
108 connector_status_connected = 1,
109 connector_status_disconnected = 2,
110 connector_status_unknown = 3,
113 enum subpixel_order {
115 SubPixelHorizontalRGB,
116 SubPixelHorizontalBGR,
122 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
123 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
124 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
126 * Describes a given display (e.g. CRT or flat panel) and its limitations.
128 struct drm_display_info {
129 char name[DRM_DISPLAY_INFO_LEN];
132 unsigned int width_mm;
133 unsigned int height_mm;
135 /* Clock limits FIXME: storage format */
136 unsigned int min_vfreq, max_vfreq;
137 unsigned int min_hfreq, max_hfreq;
138 unsigned int pixel_clock;
141 enum subpixel_order subpixel_order;
144 const u32 *bus_formats;
145 unsigned int num_bus_formats;
147 /* Mask of supported hdmi deep color modes */
148 u8 edid_hdmi_dc_modes;
153 /* data corresponds to displayid vend/prod/serial */
154 struct drm_tile_group {
155 struct kref refcount;
156 struct drm_device *dev;
161 struct drm_framebuffer_funcs {
162 /* note: use drm_framebuffer_remove() */
163 void (*destroy)(struct drm_framebuffer *framebuffer);
164 int (*create_handle)(struct drm_framebuffer *fb,
165 struct drm_file *file_priv,
166 unsigned int *handle);
168 * Optional callback for the dirty fb ioctl.
170 * Userspace can notify the driver via this callback
171 * that a area of the framebuffer has changed and should
172 * be flushed to the display hardware.
174 * See documentation in drm_mode.h for the struct
175 * drm_mode_fb_dirty_cmd for more information as all
176 * the semantics and arguments have a one to one mapping
179 int (*dirty)(struct drm_framebuffer *framebuffer,
180 struct drm_file *file_priv, unsigned flags,
181 unsigned color, struct drm_clip_rect *clips,
185 struct drm_framebuffer {
186 struct drm_device *dev;
188 * Note that the fb is refcounted for the benefit of driver internals,
189 * for example some hw, disabling a CRTC/plane is asynchronous, and
190 * scanout does not actually complete until the next vblank. So some
191 * cleanup (like releasing the reference(s) on the backing GEM bo(s))
192 * should be deferred. In cases like this, the driver would like to
193 * hold a ref to the fb even though it has already been removed from
194 * userspace perspective.
196 struct kref refcount;
198 * Place on the dev->mode_config.fb_list, access protected by
199 * dev->mode_config.fb_lock.
201 struct list_head head;
202 struct drm_mode_object base;
203 const struct drm_framebuffer_funcs *funcs;
204 unsigned int pitches[4];
205 unsigned int offsets[4];
206 uint64_t modifier[4];
209 /* depth can be 15 or 16 */
213 uint32_t pixel_format; /* fourcc format */
214 struct list_head filp_head;
217 struct drm_property_blob {
218 struct drm_mode_object base;
219 struct drm_device *dev;
220 struct kref refcount;
221 struct list_head head_global;
222 struct list_head head_file;
224 unsigned char data[];
227 struct drm_property_enum {
229 struct list_head head;
230 char name[DRM_PROP_NAME_LEN];
233 struct drm_property {
234 struct list_head head;
235 struct drm_mode_object base;
237 char name[DRM_PROP_NAME_LEN];
240 struct drm_device *dev;
242 struct list_head enum_list;
246 struct drm_connector;
248 struct drm_pending_vblank_event;
251 struct drm_atomic_state;
254 * struct drm_crtc_state - mutable CRTC state
255 * @crtc: backpointer to the CRTC
256 * @enable: whether the CRTC should be enabled, gates all other state
257 * @active: whether the CRTC is actively displaying (used for DPMS)
258 * @planes_changed: planes on this crtc are updated
259 * @mode_changed: crtc_state->mode or crtc_state->enable has been changed
260 * @active_changed: crtc_state->active has been toggled.
261 * @connectors_changed: connectors to this crtc have been updated
262 * @plane_mask: bitmask of (1 << drm_plane_index(plane)) of attached planes
263 * @last_vblank_count: for helpers and drivers to capture the vblank of the
264 * update to ensure framebuffer cleanup isn't done too early
265 * @adjusted_mode: for use by helpers and drivers to compute adjusted mode timings
266 * @mode: current mode timings
267 * @event: optional pointer to a DRM event to signal upon completion of the
269 * @state: backpointer to global drm_atomic_state
271 * Note that the distinction between @enable and @active is rather subtile:
272 * Flipping @active while @enable is set without changing anything else may
273 * never return in a failure from the ->atomic_check callback. Userspace assumes
274 * that a DPMS On will always succeed. In other words: @enable controls resource
275 * assignment, @active controls the actual hardware state.
277 struct drm_crtc_state {
278 struct drm_crtc *crtc;
283 /* computed state bits used by helpers and drivers */
284 bool planes_changed : 1;
285 bool mode_changed : 1;
286 bool active_changed : 1;
287 bool connectors_changed : 1;
289 /* attached planes bitmask:
290 * WARNING: transitional helpers do not maintain plane_mask so
291 * drivers not converted over to atomic helpers should not rely
292 * on plane_mask being accurate!
296 /* last_vblank_count: for vblank waits before cleanup */
297 u32 last_vblank_count;
299 /* adjusted_mode: for use by helpers and drivers */
300 struct drm_display_mode adjusted_mode;
302 struct drm_display_mode mode;
304 /* blob property to expose current mode to atomic userspace */
305 struct drm_property_blob *mode_blob;
307 struct drm_pending_vblank_event *event;
309 struct drm_atomic_state *state;
313 * struct drm_crtc_funcs - control CRTCs for a given device
314 * @save: save CRTC state
315 * @restore: restore CRTC state
316 * @reset: reset CRTC after state has been invalidated (e.g. resume)
317 * @cursor_set: setup the cursor
318 * @cursor_set2: setup the cursor with hotspot, superseeds @cursor_set if set
319 * @cursor_move: move the cursor
320 * @gamma_set: specify color ramp for CRTC
321 * @destroy: deinit and free object
322 * @set_property: called when a property is changed
323 * @set_config: apply a new CRTC configuration
324 * @page_flip: initiate a page flip
325 * @atomic_duplicate_state: duplicate the atomic state for this CRTC
326 * @atomic_destroy_state: destroy an atomic state for this CRTC
327 * @atomic_set_property: set a property on an atomic state for this CRTC
328 * (do not call directly, use drm_atomic_crtc_set_property())
329 * @atomic_get_property: get a property on an atomic state for this CRTC
330 * (do not call directly, use drm_atomic_crtc_get_property())
332 * The drm_crtc_funcs structure is the central CRTC management structure
333 * in the DRM. Each CRTC controls one or more connectors (note that the name
334 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
335 * connectors, not just CRTs).
337 * Each driver is responsible for filling out this structure at startup time,
338 * in addition to providing other modesetting features, like i2c and DDC
341 struct drm_crtc_funcs {
342 /* Save CRTC state */
343 void (*save)(struct drm_crtc *crtc); /* suspend? */
344 /* Restore CRTC state */
345 void (*restore)(struct drm_crtc *crtc); /* resume? */
346 /* Reset CRTC state */
347 void (*reset)(struct drm_crtc *crtc);
349 /* cursor controls */
350 int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
351 uint32_t handle, uint32_t width, uint32_t height);
352 int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
353 uint32_t handle, uint32_t width, uint32_t height,
354 int32_t hot_x, int32_t hot_y);
355 int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
357 /* Set gamma on the CRTC */
358 void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
359 uint32_t start, uint32_t size);
360 /* Object destroy routine */
361 void (*destroy)(struct drm_crtc *crtc);
363 int (*set_config)(struct drm_mode_set *set);
366 * Flip to the given framebuffer. This implements the page
367 * flip ioctl described in drm_mode.h, specifically, the
368 * implementation must return immediately and block all
369 * rendering to the current fb until the flip has completed.
370 * If userspace set the event flag in the ioctl, the event
371 * argument will point to an event to send back when the flip
372 * completes, otherwise it will be NULL.
374 int (*page_flip)(struct drm_crtc *crtc,
375 struct drm_framebuffer *fb,
376 struct drm_pending_vblank_event *event,
379 int (*set_property)(struct drm_crtc *crtc,
380 struct drm_property *property, uint64_t val);
382 /* atomic update handling */
383 struct drm_crtc_state *(*atomic_duplicate_state)(struct drm_crtc *crtc);
384 void (*atomic_destroy_state)(struct drm_crtc *crtc,
385 struct drm_crtc_state *state);
386 int (*atomic_set_property)(struct drm_crtc *crtc,
387 struct drm_crtc_state *state,
388 struct drm_property *property,
390 int (*atomic_get_property)(struct drm_crtc *crtc,
391 const struct drm_crtc_state *state,
392 struct drm_property *property,
397 * struct drm_crtc - central CRTC control structure
398 * @dev: parent DRM device
399 * @port: OF node used by drm_of_find_possible_crtcs()
400 * @head: list management
401 * @mutex: per-CRTC locking
402 * @base: base KMS object for ID tracking etc.
403 * @primary: primary plane for this CRTC
404 * @cursor: cursor plane for this CRTC
405 * @cursor_x: current x position of the cursor, used for universal cursor planes
406 * @cursor_y: current y position of the cursor, used for universal cursor planes
407 * @enabled: is this CRTC enabled?
408 * @mode: current mode timings
409 * @hwmode: mode timings as programmed to hw regs
410 * @x: x position on screen
411 * @y: y position on screen
412 * @funcs: CRTC control functions
413 * @gamma_size: size of gamma ramp
414 * @gamma_store: gamma ramp values
415 * @helper_private: mid-layer private data
416 * @properties: property tracking for this CRTC
417 * @state: current atomic state for this CRTC
418 * @acquire_ctx: per-CRTC implicit acquire context used by atomic drivers for
421 * Each CRTC may have one or more connectors associated with it. This structure
422 * allows the CRTC to be controlled.
425 struct drm_device *dev;
426 struct device_node *port;
427 struct list_head head;
432 * This provides a read lock for the overall crtc state (mode, dpms
433 * state, ...) and a write lock for everything which can be update
434 * without a full modeset (fb, cursor data, ...)
436 struct drm_modeset_lock mutex;
438 struct drm_mode_object base;
440 /* primary and cursor planes for CRTC */
441 struct drm_plane *primary;
442 struct drm_plane *cursor;
444 /* position of cursor plane on crtc */
450 /* Requested mode from modesetting. */
451 struct drm_display_mode mode;
453 /* Programmed mode in hw, after adjustments for encoders,
454 * crtc, panel scaling etc. Needed for timestamping etc.
456 struct drm_display_mode hwmode;
459 const struct drm_crtc_funcs *funcs;
461 /* CRTC gamma size for reporting to userspace */
463 uint16_t *gamma_store;
465 /* if you are using the helper */
466 const void *helper_private;
468 struct drm_object_properties properties;
470 struct drm_crtc_state *state;
473 * For legacy crtc ioctls so that atomic drivers can get at the locking
476 struct drm_modeset_acquire_ctx *acquire_ctx;
480 * struct drm_connector_state - mutable connector state
481 * @connector: backpointer to the connector
482 * @crtc: CRTC to connect connector to, NULL if disabled
483 * @best_encoder: can be used by helpers and drivers to select the encoder
484 * @state: backpointer to global drm_atomic_state
486 struct drm_connector_state {
487 struct drm_connector *connector;
489 struct drm_crtc *crtc; /* do not write directly, use drm_atomic_set_crtc_for_connector() */
491 struct drm_encoder *best_encoder;
493 struct drm_atomic_state *state;
497 * struct drm_connector_funcs - control connectors on a given device
498 * @dpms: set power state
499 * @save: save connector state
500 * @restore: restore connector state
501 * @reset: reset connector after state has been invalidated (e.g. resume)
502 * @detect: is this connector active?
503 * @fill_modes: fill mode list for this connector
504 * @set_property: property for this connector may need an update
505 * @destroy: make object go away
506 * @force: notify the driver that the connector is forced on
507 * @atomic_duplicate_state: duplicate the atomic state for this connector
508 * @atomic_destroy_state: destroy an atomic state for this connector
509 * @atomic_set_property: set a property on an atomic state for this connector
510 * (do not call directly, use drm_atomic_connector_set_property())
511 * @atomic_get_property: get a property on an atomic state for this connector
512 * (do not call directly, use drm_atomic_connector_get_property())
514 * Each CRTC may have one or more connectors attached to it. The functions
515 * below allow the core DRM code to control connectors, enumerate available modes,
518 struct drm_connector_funcs {
519 int (*dpms)(struct drm_connector *connector, int mode);
520 void (*save)(struct drm_connector *connector);
521 void (*restore)(struct drm_connector *connector);
522 void (*reset)(struct drm_connector *connector);
524 /* Check to see if anything is attached to the connector.
525 * @force is set to false whilst polling, true when checking the
526 * connector due to user request. @force can be used by the driver
527 * to avoid expensive, destructive operations during automated
530 enum drm_connector_status (*detect)(struct drm_connector *connector,
532 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
533 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
535 void (*destroy)(struct drm_connector *connector);
536 void (*force)(struct drm_connector *connector);
538 /* atomic update handling */
539 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
540 void (*atomic_destroy_state)(struct drm_connector *connector,
541 struct drm_connector_state *state);
542 int (*atomic_set_property)(struct drm_connector *connector,
543 struct drm_connector_state *state,
544 struct drm_property *property,
546 int (*atomic_get_property)(struct drm_connector *connector,
547 const struct drm_connector_state *state,
548 struct drm_property *property,
553 * struct drm_encoder_funcs - encoder controls
554 * @reset: reset state (e.g. at init or resume time)
555 * @destroy: cleanup and free associated data
557 * Encoders sit between CRTCs and connectors.
559 struct drm_encoder_funcs {
560 void (*reset)(struct drm_encoder *encoder);
561 void (*destroy)(struct drm_encoder *encoder);
564 #define DRM_CONNECTOR_MAX_ENCODER 3
567 * struct drm_encoder - central DRM encoder structure
568 * @dev: parent DRM device
569 * @head: list management
570 * @base: base KMS object
571 * @name: encoder name
572 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
573 * @possible_crtcs: bitmask of potential CRTC bindings
574 * @possible_clones: bitmask of potential sibling encoders for cloning
575 * @crtc: currently bound CRTC
576 * @bridge: bridge associated to the encoder
577 * @funcs: control functions
578 * @helper_private: mid-layer private data
580 * CRTCs drive pixels to encoders, which convert them into signals
581 * appropriate for a given connector or set of connectors.
584 struct drm_device *dev;
585 struct list_head head;
587 struct drm_mode_object base;
590 uint32_t possible_crtcs;
591 uint32_t possible_clones;
593 struct drm_crtc *crtc;
594 struct drm_bridge *bridge;
595 const struct drm_encoder_funcs *funcs;
596 const void *helper_private;
599 /* should we poll this connector for connects and disconnects */
600 /* hot plug detectable */
601 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
602 /* poll for connections */
603 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
604 /* can cleanly poll for disconnections without flickering the screen */
605 /* DACs should rarely do this without a lot of testing */
606 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
608 #define MAX_ELD_BYTES 128
611 * struct drm_connector - central DRM connector control structure
612 * @dev: parent DRM device
613 * @port: OF node used by find connector by node.
614 * @kdev: kernel device for sysfs attributes
615 * @attr: sysfs attributes
616 * @head: list management
617 * @base: base KMS object
618 * @name: connector name
619 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
620 * @connector_type_id: index into connector type enum
621 * @interlace_allowed: can this connector handle interlaced modes?
622 * @doublescan_allowed: can this connector handle doublescan?
623 * @stereo_allowed: can this connector handle stereo modes?
624 * @modes: modes available on this connector (from fill_modes() + user)
625 * @status: one of the drm_connector_status enums (connected, not, or unknown)
626 * @probed_modes: list of modes derived directly from the display
627 * @display_info: information about attached display (e.g. from EDID)
628 * @funcs: connector control functions
629 * @edid_blob_ptr: DRM property containing EDID if present
630 * @properties: property tracking for this connector
631 * @path_blob_ptr: DRM blob property data for the DP MST path property
632 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
633 * @dpms: current dpms state
634 * @helper_private: mid-layer private data
635 * @cmdline_mode: mode line parsed from the kernel cmdline for this connector
636 * @force: a %DRM_FORCE_<foo> state for forced mode sets
637 * @override_edid: has the EDID been overwritten through debugfs for testing?
638 * @encoder_ids: valid encoders for this connector
639 * @encoder: encoder driving this connector, if any
640 * @eld: EDID-like data, if present
641 * @dvi_dual: dual link DVI, if found
642 * @max_tmds_clock: max clock rate, if found
643 * @latency_present: AV delay info from ELD, if found
644 * @video_latency: video latency info from ELD, if found
645 * @audio_latency: audio latency info from ELD, if found
646 * @null_edid_counter: track sinks that give us all zeros for the EDID
647 * @bad_edid_counter: track sinks that give us an EDID with invalid checksum
648 * @edid_corrupt: indicates whether the last read EDID was corrupt
649 * @debugfs_entry: debugfs directory for this connector
650 * @state: current atomic state for this connector
651 * @has_tile: is this connector connected to a tiled monitor
652 * @tile_group: tile group for the connected monitor
653 * @tile_is_single_monitor: whether the tile is one monitor housing
654 * @num_h_tile: number of horizontal tiles in the tile group
655 * @num_v_tile: number of vertical tiles in the tile group
656 * @tile_h_loc: horizontal location of this tile
657 * @tile_v_loc: vertical location of this tile
658 * @tile_h_size: horizontal size of this tile.
659 * @tile_v_size: vertical size of this tile.
661 * Each connector may be connected to one or more CRTCs, or may be clonable by
662 * another connector if they can share a CRTC. Each connector also has a specific
663 * position in the broader display (referred to as a 'screen' though it could
664 * span multiple monitors).
666 struct drm_connector {
667 struct drm_device *dev;
668 struct device_node *port;
670 struct device_attribute *attr;
671 struct list_head head;
673 struct drm_mode_object base;
677 int connector_type_id;
678 bool interlace_allowed;
679 bool doublescan_allowed;
681 struct list_head modes; /* list of modes on this connector */
683 enum drm_connector_status status;
685 /* these are modes added by probing with DDC or the BIOS */
686 struct list_head probed_modes;
688 struct drm_display_info display_info;
689 const struct drm_connector_funcs *funcs;
691 struct drm_property_blob *edid_blob_ptr;
692 struct drm_object_properties properties;
694 struct drm_property_blob *path_blob_ptr;
696 struct drm_property_blob *tile_blob_ptr;
698 uint8_t polled; /* DRM_CONNECTOR_POLL_* */
700 /* requested DPMS state */
703 const void *helper_private;
705 /* forced on connector */
706 struct drm_cmdline_mode cmdline_mode;
707 enum drm_connector_force force;
709 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
710 struct drm_encoder *encoder; /* currently active encoder */
714 uint8_t eld[MAX_ELD_BYTES];
716 int max_tmds_clock; /* in MHz */
717 bool latency_present[2];
718 int video_latency[2]; /* [0]: progressive, [1]: interlaced */
719 int audio_latency[2];
720 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
721 unsigned bad_edid_counter;
723 /* Flag for raw EDID header corruption - used in Displayport
724 * compliance testing - * Displayport Link CTS Core 1.2 rev1.1 4.2.2.6
728 struct dentry *debugfs_entry;
730 struct drm_connector_state *state;
734 struct drm_tile_group *tile_group;
735 bool tile_is_single_monitor;
737 uint8_t num_h_tile, num_v_tile;
738 uint8_t tile_h_loc, tile_v_loc;
739 uint16_t tile_h_size, tile_v_size;
743 * struct drm_plane_state - mutable plane state
744 * @plane: backpointer to the plane
745 * @crtc: currently bound CRTC, NULL if disabled
746 * @fb: currently bound framebuffer
747 * @fence: optional fence to wait for before scanning out @fb
748 * @crtc_x: left position of visible portion of plane on crtc
749 * @crtc_y: upper position of visible portion of plane on crtc
750 * @crtc_w: width of visible portion of plane on crtc
751 * @crtc_h: height of visible portion of plane on crtc
752 * @src_x: left position of visible portion of plane within
754 * @src_y: upper position of visible portion of plane within
756 * @src_w: width of visible portion of plane (in 16.16)
757 * @src_h: height of visible portion of plane (in 16.16)
758 * @state: backpointer to global drm_atomic_state
760 struct drm_plane_state {
761 struct drm_plane *plane;
763 struct drm_crtc *crtc; /* do not write directly, use drm_atomic_set_crtc_for_plane() */
764 struct drm_framebuffer *fb; /* do not write directly, use drm_atomic_set_fb_for_plane() */
767 /* Signed dest location allows it to be partially off screen */
768 int32_t crtc_x, crtc_y;
769 uint32_t crtc_w, crtc_h;
771 /* Source values are 16.16 fixed point */
772 uint32_t src_x, src_y;
773 uint32_t src_h, src_w;
776 unsigned int rotation;
778 struct drm_atomic_state *state;
783 * struct drm_plane_funcs - driver plane control functions
784 * @update_plane: update the plane configuration
785 * @disable_plane: shut down the plane
786 * @destroy: clean up plane resources
787 * @reset: reset plane after state has been invalidated (e.g. resume)
788 * @set_property: called when a property is changed
789 * @atomic_duplicate_state: duplicate the atomic state for this plane
790 * @atomic_destroy_state: destroy an atomic state for this plane
791 * @atomic_set_property: set a property on an atomic state for this plane
792 * (do not call directly, use drm_atomic_plane_set_property())
793 * @atomic_get_property: get a property on an atomic state for this plane
794 * (do not call directly, use drm_atomic_plane_get_property())
796 struct drm_plane_funcs {
797 int (*update_plane)(struct drm_plane *plane,
798 struct drm_crtc *crtc, struct drm_framebuffer *fb,
799 int crtc_x, int crtc_y,
800 unsigned int crtc_w, unsigned int crtc_h,
801 uint32_t src_x, uint32_t src_y,
802 uint32_t src_w, uint32_t src_h);
803 int (*disable_plane)(struct drm_plane *plane);
804 void (*destroy)(struct drm_plane *plane);
805 void (*reset)(struct drm_plane *plane);
807 int (*set_property)(struct drm_plane *plane,
808 struct drm_property *property, uint64_t val);
810 /* atomic update handling */
811 struct drm_plane_state *(*atomic_duplicate_state)(struct drm_plane *plane);
812 void (*atomic_destroy_state)(struct drm_plane *plane,
813 struct drm_plane_state *state);
814 int (*atomic_set_property)(struct drm_plane *plane,
815 struct drm_plane_state *state,
816 struct drm_property *property,
818 int (*atomic_get_property)(struct drm_plane *plane,
819 const struct drm_plane_state *state,
820 struct drm_property *property,
824 enum drm_plane_type {
825 DRM_PLANE_TYPE_OVERLAY,
826 DRM_PLANE_TYPE_PRIMARY,
827 DRM_PLANE_TYPE_CURSOR,
831 * struct drm_plane - central DRM plane control structure
832 * @dev: DRM device this plane belongs to
833 * @parent: this plane share some resources with parent plane.
834 * @head: for list management
835 * @base: base mode object
836 * @possible_crtcs: pipes this plane can be bound to
837 * @format_types: array of formats supported by this plane
838 * @format_count: number of formats supported
839 * @format_default: driver hasn't supplied supported formats for the plane
840 * @crtc: currently bound CRTC
841 * @fb: currently bound fb
842 * @old_fb: Temporary tracking of the old fb while a modeset is ongoing. Used by
843 * drm_mode_set_config_internal() to implement correct refcounting.
844 * @funcs: helper functions
845 * @properties: property tracking for this plane
846 * @type: type of plane (overlay, primary, cursor)
847 * @state: current atomic state for this plane
850 struct drm_device *dev;
851 struct drm_plane *parent;
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 mutex 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 mutex 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 mutex 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 int num_share_plane;
1083 int num_share_overlay_plane;
1084 struct list_head plane_list;
1087 struct list_head crtc_list;
1089 struct list_head property_list;
1091 int min_width, min_height;
1092 int max_width, max_height;
1093 const struct drm_mode_config_funcs *funcs;
1094 resource_size_t fb_base;
1096 /* output poll support */
1100 struct delayed_work output_poll_work;
1102 struct mutex blob_lock;
1104 /* pointers to share properties */
1105 struct drm_property *prop_share_id;
1106 struct drm_property *prop_share_flags;
1108 /* pointers to standard properties */
1109 struct list_head property_blob_list;
1110 struct drm_property *edid_property;
1111 struct drm_property *dpms_property;
1112 struct drm_property *path_property;
1113 struct drm_property *tile_property;
1114 struct drm_property *plane_type_property;
1115 struct drm_property *rotation_property;
1116 struct drm_property *prop_src_x;
1117 struct drm_property *prop_src_y;
1118 struct drm_property *prop_src_w;
1119 struct drm_property *prop_src_h;
1120 struct drm_property *prop_crtc_x;
1121 struct drm_property *prop_crtc_y;
1122 struct drm_property *prop_crtc_w;
1123 struct drm_property *prop_crtc_h;
1124 struct drm_property *prop_fb_id;
1125 struct drm_property *prop_crtc_id;
1126 struct drm_property *prop_active;
1127 struct drm_property *prop_mode_id;
1129 /* DVI-I properties */
1130 struct drm_property *dvi_i_subconnector_property;
1131 struct drm_property *dvi_i_select_subconnector_property;
1134 struct drm_property *tv_subconnector_property;
1135 struct drm_property *tv_select_subconnector_property;
1136 struct drm_property *tv_mode_property;
1137 struct drm_property *tv_left_margin_property;
1138 struct drm_property *tv_right_margin_property;
1139 struct drm_property *tv_top_margin_property;
1140 struct drm_property *tv_bottom_margin_property;
1141 struct drm_property *tv_brightness_property;
1142 struct drm_property *tv_contrast_property;
1143 struct drm_property *tv_flicker_reduction_property;
1144 struct drm_property *tv_overscan_property;
1145 struct drm_property *tv_saturation_property;
1146 struct drm_property *tv_hue_property;
1148 /* Optional properties */
1149 struct drm_property *scaling_mode_property;
1150 struct drm_property *aspect_ratio_property;
1151 struct drm_property *dirty_info_property;
1153 /* properties for virtual machine layout */
1154 struct drm_property *suggested_x_property;
1155 struct drm_property *suggested_y_property;
1157 /* dumb ioctl parameters */
1158 uint32_t preferred_depth, prefer_shadow;
1160 /* whether async page flip is supported or not */
1161 bool async_page_flip;
1163 /* whether the driver supports fb modifiers */
1164 bool allow_fb_modifiers;
1167 uint32_t cursor_width, cursor_height;
1171 * drm_for_each_plane_mask - iterate over planes specified by bitmask
1172 * @plane: the loop cursor
1173 * @dev: the DRM device
1174 * @plane_mask: bitmask of plane indices
1176 * Iterate over all planes specified by bitmask.
1178 #define drm_for_each_plane_mask(plane, dev, plane_mask) \
1179 list_for_each_entry((plane), &(dev)->mode_config.plane_list, head) \
1180 if ((plane_mask) & (1 << drm_plane_index(plane)))
1183 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
1184 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
1185 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
1186 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
1187 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
1188 #define obj_to_property(x) container_of(x, struct drm_property, base)
1189 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
1190 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
1192 struct drm_prop_enum_list {
1197 extern __printf(6, 7)
1198 int drm_crtc_init_with_planes(struct drm_device *dev,
1199 struct drm_crtc *crtc,
1200 struct drm_plane *primary,
1201 struct drm_plane *cursor,
1202 const struct drm_crtc_funcs *funcs,
1203 const char *name, ...);
1204 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
1205 extern unsigned int drm_crtc_index(struct drm_crtc *crtc);
1208 * drm_crtc_mask - find the mask of a registered CRTC
1209 * @crtc: CRTC to find mask for
1211 * Given a registered CRTC, return the mask bit of that CRTC for an
1212 * encoder's possible_crtcs field.
1214 static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
1216 return 1 << drm_crtc_index(crtc);
1219 extern void drm_connector_ida_init(void);
1220 extern void drm_connector_ida_destroy(void);
1221 extern int drm_connector_init(struct drm_device *dev,
1222 struct drm_connector *connector,
1223 const struct drm_connector_funcs *funcs,
1224 int connector_type);
1225 int drm_connector_register(struct drm_connector *connector);
1226 void drm_connector_unregister(struct drm_connector *connector);
1228 extern void drm_connector_cleanup(struct drm_connector *connector);
1229 extern unsigned int drm_connector_index(struct drm_connector *connector);
1230 /* helper to unplug all connectors from sysfs for device */
1231 extern void drm_connector_unplug_all(struct drm_device *dev);
1233 extern int drm_bridge_add(struct drm_bridge *bridge);
1234 extern void drm_bridge_remove(struct drm_bridge *bridge);
1235 extern struct drm_bridge *of_drm_find_bridge(struct device_node *np);
1236 extern int drm_bridge_attach(struct drm_device *dev, struct drm_bridge *bridge);
1238 bool drm_bridge_mode_fixup(struct drm_bridge *bridge,
1239 const struct drm_display_mode *mode,
1240 struct drm_display_mode *adjusted_mode);
1241 void drm_bridge_disable(struct drm_bridge *bridge);
1242 void drm_bridge_post_disable(struct drm_bridge *bridge);
1243 void drm_bridge_mode_set(struct drm_bridge *bridge,
1244 struct drm_display_mode *mode,
1245 struct drm_display_mode *adjusted_mode);
1246 void drm_bridge_pre_enable(struct drm_bridge *bridge);
1247 void drm_bridge_enable(struct drm_bridge *bridge);
1249 extern __printf(5, 6)
1250 int drm_encoder_init(struct drm_device *dev,
1251 struct drm_encoder *encoder,
1252 const struct drm_encoder_funcs *funcs,
1253 int encoder_type, const char *name, ...);
1256 * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
1257 * @encoder: encoder to test
1258 * @crtc: crtc to test
1260 * Return false if @encoder can't be driven by @crtc, true otherwise.
1262 static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
1263 struct drm_crtc *crtc)
1265 return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
1268 extern __printf(8, 9)
1269 int drm_universal_plane_init(struct drm_device *dev,
1270 struct drm_plane *plane,
1271 unsigned long possible_crtcs,
1272 const struct drm_plane_funcs *funcs,
1273 const uint32_t *formats,
1274 unsigned int format_count,
1275 enum drm_plane_type type,
1276 const char *name, ...);
1277 extern int drm_plane_init(struct drm_device *dev,
1278 struct drm_plane *plane,
1279 unsigned long possible_crtcs,
1280 const struct drm_plane_funcs *funcs,
1281 const uint32_t *formats, unsigned int format_count,
1283 extern int drm_share_plane_init(struct drm_device *dev, struct drm_plane *plane,
1284 struct drm_plane *parent,
1285 unsigned long possible_crtcs,
1286 const struct drm_plane_funcs *funcs,
1287 const uint32_t *formats,
1288 unsigned int format_count,
1289 enum drm_plane_type type);
1290 extern void drm_plane_cleanup(struct drm_plane *plane);
1291 extern unsigned int drm_plane_index(struct drm_plane *plane);
1292 extern struct drm_plane * drm_plane_from_index(struct drm_device *dev, int idx);
1293 extern void drm_plane_force_disable(struct drm_plane *plane);
1294 extern int drm_plane_check_pixel_format(const struct drm_plane *plane,
1296 extern void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
1297 int *hdisplay, int *vdisplay);
1298 extern int drm_crtc_check_viewport(const struct drm_crtc *crtc,
1300 const struct drm_display_mode *mode,
1301 const struct drm_framebuffer *fb);
1303 extern void drm_encoder_cleanup(struct drm_encoder *encoder);
1305 extern const char *drm_get_connector_status_name(enum drm_connector_status status);
1306 extern const char *drm_get_subpixel_order_name(enum subpixel_order order);
1307 extern const char *drm_get_dpms_name(int val);
1308 extern const char *drm_get_dvi_i_subconnector_name(int val);
1309 extern const char *drm_get_dvi_i_select_name(int val);
1310 extern const char *drm_get_tv_subconnector_name(int val);
1311 extern const char *drm_get_tv_select_name(int val);
1312 extern void drm_fb_release(struct drm_file *file_priv);
1313 extern void drm_property_destroy_user_blobs(struct drm_device *dev,
1314 struct drm_file *file_priv);
1315 extern bool drm_probe_ddc(struct i2c_adapter *adapter);
1316 extern struct edid *drm_get_edid(struct drm_connector *connector,
1317 struct i2c_adapter *adapter);
1318 extern struct edid *drm_edid_duplicate(const struct edid *edid);
1319 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
1320 extern void drm_mode_config_init(struct drm_device *dev);
1321 extern void drm_mode_config_reset(struct drm_device *dev);
1322 extern void drm_mode_config_cleanup(struct drm_device *dev);
1324 extern int drm_mode_connector_set_path_property(struct drm_connector *connector,
1326 int drm_mode_connector_set_tile_property(struct drm_connector *connector);
1327 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
1328 const struct edid *edid);
1330 extern int drm_display_info_set_bus_formats(struct drm_display_info *info,
1332 unsigned int num_formats);
1334 static inline bool drm_property_type_is(struct drm_property *property,
1337 /* instanceof for props.. handles extended type vs original types: */
1338 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
1339 return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;
1340 return property->flags & type;
1343 static inline bool drm_property_type_valid(struct drm_property *property)
1345 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
1346 return !(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
1347 return !!(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
1350 extern int drm_object_property_set_value(struct drm_mode_object *obj,
1351 struct drm_property *property,
1353 extern int drm_object_property_get_value(struct drm_mode_object *obj,
1354 struct drm_property *property,
1356 extern int drm_framebuffer_init(struct drm_device *dev,
1357 struct drm_framebuffer *fb,
1358 const struct drm_framebuffer_funcs *funcs);
1359 extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
1361 extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
1362 extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
1363 extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
1364 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
1365 extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
1367 extern void drm_object_attach_property(struct drm_mode_object *obj,
1368 struct drm_property *property,
1370 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
1371 const char *name, int num_values);
1372 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
1374 const struct drm_prop_enum_list *props,
1376 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
1377 int flags, const char *name,
1378 const struct drm_prop_enum_list *props,
1380 uint64_t supported_bits);
1381 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
1383 uint64_t min, uint64_t max);
1384 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
1385 int flags, const char *name,
1386 int64_t min, int64_t max);
1387 struct drm_property *drm_property_create_object(struct drm_device *dev,
1388 int flags, const char *name, uint32_t type);
1389 struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags,
1391 struct drm_property_blob *drm_property_create_blob(struct drm_device *dev,
1394 struct drm_property_blob *drm_property_lookup_blob(struct drm_device *dev,
1396 struct drm_property_blob *drm_property_reference_blob(struct drm_property_blob *blob);
1397 void drm_property_unreference_blob(struct drm_property_blob *blob);
1398 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
1399 extern int drm_property_add_enum(struct drm_property *property, int index,
1400 uint64_t value, const char *name);
1401 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1402 extern int drm_mode_create_tv_properties(struct drm_device *dev,
1403 unsigned int num_modes,
1404 const char * const modes[]);
1405 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1406 extern int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1407 extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
1408 extern int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
1409 extern bool drm_property_change_valid_get(struct drm_property *property,
1410 uint64_t value, struct drm_mode_object **ref);
1411 extern void drm_property_change_valid_put(struct drm_property *property,
1412 struct drm_mode_object *ref);
1414 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
1415 struct drm_encoder *encoder);
1416 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
1418 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
1419 uint32_t id, uint32_t type);
1422 extern int drm_mode_getresources(struct drm_device *dev,
1423 void *data, struct drm_file *file_priv);
1424 extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
1425 struct drm_file *file_priv);
1426 extern int drm_mode_getcrtc(struct drm_device *dev,
1427 void *data, struct drm_file *file_priv);
1428 extern int drm_mode_getconnector(struct drm_device *dev,
1429 void *data, struct drm_file *file_priv);
1430 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
1431 extern int drm_mode_setcrtc(struct drm_device *dev,
1432 void *data, struct drm_file *file_priv);
1433 extern int drm_mode_getplane(struct drm_device *dev,
1434 void *data, struct drm_file *file_priv);
1435 extern int drm_mode_setplane(struct drm_device *dev,
1436 void *data, struct drm_file *file_priv);
1437 extern int drm_mode_cursor_ioctl(struct drm_device *dev,
1438 void *data, struct drm_file *file_priv);
1439 extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
1440 void *data, struct drm_file *file_priv);
1441 extern int drm_mode_addfb(struct drm_device *dev,
1442 void *data, struct drm_file *file_priv);
1443 extern int drm_mode_addfb2(struct drm_device *dev,
1444 void *data, struct drm_file *file_priv);
1445 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
1446 extern int drm_mode_rmfb(struct drm_device *dev,
1447 void *data, struct drm_file *file_priv);
1448 extern int drm_mode_getfb(struct drm_device *dev,
1449 void *data, struct drm_file *file_priv);
1450 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1451 void *data, struct drm_file *file_priv);
1453 extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1454 void *data, struct drm_file *file_priv);
1455 extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1456 void *data, struct drm_file *file_priv);
1457 extern int drm_mode_createblob_ioctl(struct drm_device *dev,
1458 void *data, struct drm_file *file_priv);
1459 extern int drm_mode_destroyblob_ioctl(struct drm_device *dev,
1460 void *data, struct drm_file *file_priv);
1461 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1462 void *data, struct drm_file *file_priv);
1463 extern int drm_mode_getencoder(struct drm_device *dev,
1464 void *data, struct drm_file *file_priv);
1465 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1466 void *data, struct drm_file *file_priv);
1467 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1468 void *data, struct drm_file *file_priv);
1469 extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
1470 extern enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code);
1471 extern bool drm_detect_hdmi_monitor(struct edid *edid);
1472 extern bool drm_detect_monitor_audio(struct edid *edid);
1473 extern bool drm_rgb_quant_range_selectable(struct edid *edid);
1474 extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1475 void *data, struct drm_file *file_priv);
1476 extern int drm_add_modes_noedid(struct drm_connector *connector,
1477 int hdisplay, int vdisplay);
1478 extern void drm_set_preferred_mode(struct drm_connector *connector,
1479 int hpref, int vpref);
1481 extern int drm_edid_header_is_valid(const u8 *raw_edid);
1482 extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid,
1483 bool *edid_corrupt);
1484 extern bool drm_edid_is_valid(struct edid *edid);
1486 extern struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1488 extern struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1490 extern void drm_mode_put_tile_group(struct drm_device *dev,
1491 struct drm_tile_group *tg);
1492 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
1493 int hsize, int vsize, int fresh,
1496 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1497 void *data, struct drm_file *file_priv);
1498 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1499 void *data, struct drm_file *file_priv);
1500 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1501 void *data, struct drm_file *file_priv);
1502 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1503 struct drm_file *file_priv);
1504 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1505 struct drm_file *file_priv);
1506 extern int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
1507 struct drm_property *property,
1509 extern int drm_mode_atomic_ioctl(struct drm_device *dev,
1510 void *data, struct drm_file *file_priv);
1512 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1514 extern int drm_format_num_planes(uint32_t format);
1515 extern int drm_format_plane_bpp(uint32_t format, int plane);
1516 extern int drm_format_plane_cpp(uint32_t format, int plane);
1517 extern int drm_format_horz_chroma_subsampling(uint32_t format);
1518 extern int drm_format_vert_chroma_subsampling(uint32_t format);
1519 extern const char *drm_get_format_name(uint32_t format);
1520 extern struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
1521 unsigned int supported_rotations);
1522 extern unsigned int drm_rotation_simplify(unsigned int rotation,
1523 unsigned int supported_rotations);
1527 static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
1530 struct drm_mode_object *mo;
1531 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE);
1532 return mo ? obj_to_plane(mo) : NULL;
1535 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1538 struct drm_mode_object *mo;
1539 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1540 return mo ? obj_to_crtc(mo) : NULL;
1543 static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
1546 struct drm_mode_object *mo;
1547 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
1548 return mo ? obj_to_encoder(mo) : NULL;
1551 static inline struct drm_connector *drm_connector_find(struct drm_device *dev,
1554 struct drm_mode_object *mo;
1555 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR);
1556 return mo ? obj_to_connector(mo) : NULL;
1559 static inline struct drm_property *drm_property_find(struct drm_device *dev,
1562 struct drm_mode_object *mo;
1563 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY);
1564 return mo ? obj_to_property(mo) : NULL;
1567 /* Plane list iterator for legacy (overlay only) planes. */
1568 #define drm_for_each_legacy_plane(plane, dev) \
1569 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) \
1570 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1572 #define drm_for_each_plane(plane, dev) \
1573 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head)
1575 #define drm_for_each_crtc(crtc, dev) \
1576 list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)
1579 assert_drm_connector_list_read_locked(struct drm_mode_config *mode_config)
1582 * The connector hotadd/remove code currently grabs both locks when
1583 * updating lists. Hence readers need only hold either of them to be
1584 * safe and the check amounts to
1586 * WARN_ON(not_holding(A) && not_holding(B)).
1588 WARN_ON(!mutex_is_locked(&mode_config->mutex) &&
1589 !drm_modeset_is_locked(&mode_config->connection_mutex));
1592 #define drm_for_each_connector(connector, dev) \
1593 for (assert_drm_connector_list_read_locked(&(dev)->mode_config), \
1594 connector = list_first_entry(&(dev)->mode_config.connector_list, \
1595 struct drm_connector, head); \
1596 &connector->head != (&(dev)->mode_config.connector_list); \
1597 connector = list_next_entry(connector, head))
1599 #define drm_for_each_encoder(encoder, dev) \
1600 list_for_each_entry(encoder, &(dev)->mode_config.encoder_list, head)
1602 #define drm_for_each_fb(fb, dev) \
1603 for (WARN_ON(!mutex_is_locked(&(dev)->mode_config.fb_lock)), \
1604 fb = list_first_entry(&(dev)->mode_config.fb_list, \
1605 struct drm_framebuffer, head); \
1606 &fb->head != (&(dev)->mode_config.fb_list); \
1607 fb = list_next_entry(fb, head))
1609 #endif /* __DRM_CRTC_H__ */