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,
398 * This optional hook can be used to register additional userspace
399 * interfaces attached to the crtc like debugfs interfaces.
400 * It is called late in the driver load sequence from drm_dev_register().
401 * Everything added from this callback should be unregistered in
402 * the early_unregister callback.
406 * 0 on success, or a negative error code on failure.
408 int (*late_register)(struct drm_crtc *crtc);
413 * This optional hook should be used to unregister the additional
414 * userspace interfaces attached to the crtc from
415 * late_unregister(). It is called from drm_dev_unregister(),
416 * early in the driver unload sequence to disable userspace access
417 * before data structures are torndown.
419 void (*early_unregister)(struct drm_crtc *crtc);
423 * struct drm_crtc - central CRTC control structure
424 * @dev: parent DRM device
425 * @port: OF node used by drm_of_find_possible_crtcs()
426 * @head: list management
427 * @mutex: per-CRTC locking
428 * @base: base KMS object for ID tracking etc.
429 * @primary: primary plane for this CRTC
430 * @cursor: cursor plane for this CRTC
431 * @cursor_x: current x position of the cursor, used for universal cursor planes
432 * @cursor_y: current y position of the cursor, used for universal cursor planes
433 * @enabled: is this CRTC enabled?
434 * @mode: current mode timings
435 * @hwmode: mode timings as programmed to hw regs
436 * @x: x position on screen
437 * @y: y position on screen
438 * @funcs: CRTC control functions
439 * @gamma_size: size of gamma ramp
440 * @gamma_store: gamma ramp values
441 * @helper_private: mid-layer private data
442 * @properties: property tracking for this CRTC
443 * @state: current atomic state for this CRTC
444 * @acquire_ctx: per-CRTC implicit acquire context used by atomic drivers for
447 * Each CRTC may have one or more connectors associated with it. This structure
448 * allows the CRTC to be controlled.
451 struct drm_device *dev;
452 struct device_node *port;
453 struct list_head head;
458 * This provides a read lock for the overall crtc state (mode, dpms
459 * state, ...) and a write lock for everything which can be update
460 * without a full modeset (fb, cursor data, ...)
462 struct drm_modeset_lock mutex;
464 struct drm_mode_object base;
466 /* primary and cursor planes for CRTC */
467 struct drm_plane *primary;
468 struct drm_plane *cursor;
470 /* position of cursor plane on crtc */
476 /* Requested mode from modesetting. */
477 struct drm_display_mode mode;
479 /* Programmed mode in hw, after adjustments for encoders,
480 * crtc, panel scaling etc. Needed for timestamping etc.
482 struct drm_display_mode hwmode;
485 const struct drm_crtc_funcs *funcs;
487 /* CRTC gamma size for reporting to userspace */
489 uint16_t *gamma_store;
491 /* if you are using the helper */
492 const void *helper_private;
494 struct drm_object_properties properties;
496 struct drm_crtc_state *state;
499 * For legacy crtc ioctls so that atomic drivers can get at the locking
502 struct drm_modeset_acquire_ctx *acquire_ctx;
506 * struct drm_connector_state - mutable connector state
507 * @connector: backpointer to the connector
508 * @crtc: CRTC to connect connector to, NULL if disabled
509 * @best_encoder: can be used by helpers and drivers to select the encoder
510 * @state: backpointer to global drm_atomic_state
512 struct drm_connector_state {
513 struct drm_connector *connector;
515 struct drm_crtc *crtc; /* do not write directly, use drm_atomic_set_crtc_for_connector() */
517 struct drm_encoder *best_encoder;
519 struct drm_atomic_state *state;
523 * struct drm_connector_funcs - control connectors on a given device
524 * @dpms: set power state
525 * @save: save connector state
526 * @restore: restore connector state
527 * @reset: reset connector after state has been invalidated (e.g. resume)
528 * @detect: is this connector active?
529 * @fill_modes: fill mode list for this connector
530 * @set_property: property for this connector may need an update
531 * @destroy: make object go away
532 * @force: notify the driver that the connector is forced on
533 * @atomic_duplicate_state: duplicate the atomic state for this connector
534 * @atomic_destroy_state: destroy an atomic state for this connector
535 * @atomic_set_property: set a property on an atomic state for this connector
536 * (do not call directly, use drm_atomic_connector_set_property())
537 * @atomic_get_property: get a property on an atomic state for this connector
538 * (do not call directly, use drm_atomic_connector_get_property())
540 * Each CRTC may have one or more connectors attached to it. The functions
541 * below allow the core DRM code to control connectors, enumerate available modes,
544 struct drm_connector_funcs {
545 int (*dpms)(struct drm_connector *connector, int mode);
546 void (*save)(struct drm_connector *connector);
547 void (*restore)(struct drm_connector *connector);
548 void (*reset)(struct drm_connector *connector);
550 /* Check to see if anything is attached to the connector.
551 * @force is set to false whilst polling, true when checking the
552 * connector due to user request. @force can be used by the driver
553 * to avoid expensive, destructive operations during automated
556 enum drm_connector_status (*detect)(struct drm_connector *connector,
558 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
559 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
565 * This optional hook can be used to register additional userspace
566 * interfaces attached to the connector, light backlight control, i2c,
567 * DP aux or similar interfaces. It is called late in the driver load
568 * sequence from drm_connector_register() when registering all the
569 * core drm connector interfaces. Everything added from this callback
570 * should be unregistered in the early_unregister callback.
574 * 0 on success, or a negative error code on failure.
576 int (*late_register)(struct drm_connector *connector);
581 * This optional hook should be used to unregister the additional
582 * userspace interfaces attached to the connector from
583 * late_unregister(). It is called from drm_connector_unregister(),
584 * early in the driver unload sequence to disable userspace access
585 * before data structures are torndown.
587 void (*early_unregister)(struct drm_connector *connector);
589 void (*destroy)(struct drm_connector *connector);
590 void (*force)(struct drm_connector *connector);
592 /* atomic update handling */
593 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
594 void (*atomic_destroy_state)(struct drm_connector *connector,
595 struct drm_connector_state *state);
596 int (*atomic_set_property)(struct drm_connector *connector,
597 struct drm_connector_state *state,
598 struct drm_property *property,
600 int (*atomic_get_property)(struct drm_connector *connector,
601 const struct drm_connector_state *state,
602 struct drm_property *property,
607 * struct drm_encoder_funcs - encoder controls
608 * @reset: reset state (e.g. at init or resume time)
609 * @destroy: cleanup and free associated data
611 * Encoders sit between CRTCs and connectors.
613 struct drm_encoder_funcs {
614 void (*reset)(struct drm_encoder *encoder);
615 void (*destroy)(struct drm_encoder *encoder);
620 * This optional hook can be used to register additional userspace
621 * interfaces attached to the encoder like debugfs interfaces.
622 * It is called late in the driver load sequence from drm_dev_register().
623 * Everything added from this callback should be unregistered in
624 * the early_unregister callback.
628 * 0 on success, or a negative error code on failure.
630 int (*late_register)(struct drm_encoder *encoder);
635 * This optional hook should be used to unregister the additional
636 * userspace interfaces attached to the encoder from
637 * late_unregister(). It is called from drm_dev_unregister(),
638 * early in the driver unload sequence to disable userspace access
639 * before data structures are torndown.
641 void (*early_unregister)(struct drm_encoder *encoder);
644 #define DRM_CONNECTOR_MAX_ENCODER 3
647 * struct drm_encoder - central DRM encoder structure
648 * @dev: parent DRM device
649 * @head: list management
650 * @base: base KMS object
651 * @name: encoder name
652 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
653 * @possible_crtcs: bitmask of potential CRTC bindings
654 * @possible_clones: bitmask of potential sibling encoders for cloning
655 * @crtc: currently bound CRTC
656 * @bridge: bridge associated to the encoder
657 * @funcs: control functions
658 * @helper_private: mid-layer private data
660 * CRTCs drive pixels to encoders, which convert them into signals
661 * appropriate for a given connector or set of connectors.
664 struct drm_device *dev;
665 struct list_head head;
667 struct drm_mode_object base;
670 uint32_t possible_crtcs;
671 uint32_t possible_clones;
673 struct drm_crtc *crtc;
674 struct drm_bridge *bridge;
675 const struct drm_encoder_funcs *funcs;
676 const void *helper_private;
679 /* should we poll this connector for connects and disconnects */
680 /* hot plug detectable */
681 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
682 /* poll for connections */
683 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
684 /* can cleanly poll for disconnections without flickering the screen */
685 /* DACs should rarely do this without a lot of testing */
686 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
688 #define MAX_ELD_BYTES 128
691 * struct drm_connector - central DRM connector control structure
692 * @dev: parent DRM device
693 * @port: OF node used by find connector by node.
694 * @kdev: kernel device for sysfs attributes
695 * @attr: sysfs attributes
696 * @head: list management
697 * @base: base KMS object
698 * @name: connector name
699 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
700 * @connector_type_id: index into connector type enum
701 * @interlace_allowed: can this connector handle interlaced modes?
702 * @doublescan_allowed: can this connector handle doublescan?
703 * @stereo_allowed: can this connector handle stereo modes?
704 * @modes: modes available on this connector (from fill_modes() + user)
705 * @status: one of the drm_connector_status enums (connected, not, or unknown)
706 * @probed_modes: list of modes derived directly from the display
707 * @display_info: information about attached display (e.g. from EDID)
708 * @funcs: connector control functions
709 * @edid_blob_ptr: DRM property containing EDID if present
710 * @properties: property tracking for this connector
711 * @path_blob_ptr: DRM blob property data for the DP MST path property
712 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
713 * @dpms: current dpms state
714 * @helper_private: mid-layer private data
715 * @cmdline_mode: mode line parsed from the kernel cmdline for this connector
716 * @force: a %DRM_FORCE_<foo> state for forced mode sets
717 * @override_edid: has the EDID been overwritten through debugfs for testing?
718 * @encoder_ids: valid encoders for this connector
719 * @encoder: encoder driving this connector, if any
720 * @eld: EDID-like data, if present
721 * @dvi_dual: dual link DVI, if found
722 * @max_tmds_clock: max clock rate, if found
723 * @latency_present: AV delay info from ELD, if found
724 * @video_latency: video latency info from ELD, if found
725 * @audio_latency: audio latency info from ELD, if found
726 * @null_edid_counter: track sinks that give us all zeros for the EDID
727 * @bad_edid_counter: track sinks that give us an EDID with invalid checksum
728 * @edid_corrupt: indicates whether the last read EDID was corrupt
729 * @debugfs_entry: debugfs directory for this connector
730 * @state: current atomic state for this connector
731 * @has_tile: is this connector connected to a tiled monitor
732 * @tile_group: tile group for the connected monitor
733 * @tile_is_single_monitor: whether the tile is one monitor housing
734 * @num_h_tile: number of horizontal tiles in the tile group
735 * @num_v_tile: number of vertical tiles in the tile group
736 * @tile_h_loc: horizontal location of this tile
737 * @tile_v_loc: vertical location of this tile
738 * @tile_h_size: horizontal size of this tile.
739 * @tile_v_size: vertical size of this tile.
741 * Each connector may be connected to one or more CRTCs, or may be clonable by
742 * another connector if they can share a CRTC. Each connector also has a specific
743 * position in the broader display (referred to as a 'screen' though it could
744 * span multiple monitors).
746 struct drm_connector {
747 struct drm_device *dev;
748 struct device_node *port;
750 struct device_attribute *attr;
751 struct list_head head;
753 struct drm_mode_object base;
757 int connector_type_id;
758 bool interlace_allowed;
759 bool doublescan_allowed;
761 struct list_head modes; /* list of modes on this connector */
763 enum drm_connector_status status;
765 /* these are modes added by probing with DDC or the BIOS */
766 struct list_head probed_modes;
768 struct drm_display_info display_info;
769 const struct drm_connector_funcs *funcs;
771 struct drm_property_blob *edid_blob_ptr;
772 struct drm_object_properties properties;
774 struct drm_property_blob *path_blob_ptr;
776 struct drm_property_blob *tile_blob_ptr;
778 uint8_t polled; /* DRM_CONNECTOR_POLL_* */
780 /* requested DPMS state */
783 const void *helper_private;
785 /* forced on connector */
786 struct drm_cmdline_mode cmdline_mode;
787 enum drm_connector_force force;
789 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
790 struct drm_encoder *encoder; /* currently active encoder */
794 uint8_t eld[MAX_ELD_BYTES];
796 int max_tmds_clock; /* in MHz */
797 bool latency_present[2];
798 int video_latency[2]; /* [0]: progressive, [1]: interlaced */
799 int audio_latency[2];
800 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
801 unsigned bad_edid_counter;
803 /* Flag for raw EDID header corruption - used in Displayport
804 * compliance testing - * Displayport Link CTS Core 1.2 rev1.1 4.2.2.6
808 struct dentry *debugfs_entry;
810 struct drm_connector_state *state;
814 struct drm_tile_group *tile_group;
815 bool tile_is_single_monitor;
817 uint8_t num_h_tile, num_v_tile;
818 uint8_t tile_h_loc, tile_v_loc;
819 uint16_t tile_h_size, tile_v_size;
823 * struct drm_plane_state - mutable plane state
824 * @plane: backpointer to the plane
825 * @crtc: currently bound CRTC, NULL if disabled
826 * @fb: currently bound framebuffer
827 * @fence: optional fence to wait for before scanning out @fb
828 * @crtc_x: left position of visible portion of plane on crtc
829 * @crtc_y: upper position of visible portion of plane on crtc
830 * @crtc_w: width of visible portion of plane on crtc
831 * @crtc_h: height of visible portion of plane on crtc
832 * @src_x: left position of visible portion of plane within
834 * @src_y: upper position of visible portion of plane within
836 * @src_w: width of visible portion of plane (in 16.16)
837 * @src_h: height of visible portion of plane (in 16.16)
838 * @state: backpointer to global drm_atomic_state
840 struct drm_plane_state {
841 struct drm_plane *plane;
843 struct drm_crtc *crtc; /* do not write directly, use drm_atomic_set_crtc_for_plane() */
844 struct drm_framebuffer *fb; /* do not write directly, use drm_atomic_set_fb_for_plane() */
847 /* Signed dest location allows it to be partially off screen */
848 int32_t crtc_x, crtc_y;
849 uint32_t crtc_w, crtc_h;
851 /* Source values are 16.16 fixed point */
852 uint32_t src_x, src_y;
853 uint32_t src_h, src_w;
856 unsigned int rotation;
858 struct drm_atomic_state *state;
863 * struct drm_plane_funcs - driver plane control functions
864 * @update_plane: update the plane configuration
865 * @disable_plane: shut down the plane
866 * @destroy: clean up plane resources
867 * @reset: reset plane after state has been invalidated (e.g. resume)
868 * @set_property: called when a property is changed
869 * @atomic_duplicate_state: duplicate the atomic state for this plane
870 * @atomic_destroy_state: destroy an atomic state for this plane
871 * @atomic_set_property: set a property on an atomic state for this plane
872 * (do not call directly, use drm_atomic_plane_set_property())
873 * @atomic_get_property: get a property on an atomic state for this plane
874 * (do not call directly, use drm_atomic_plane_get_property())
876 struct drm_plane_funcs {
877 int (*update_plane)(struct drm_plane *plane,
878 struct drm_crtc *crtc, struct drm_framebuffer *fb,
879 int crtc_x, int crtc_y,
880 unsigned int crtc_w, unsigned int crtc_h,
881 uint32_t src_x, uint32_t src_y,
882 uint32_t src_w, uint32_t src_h);
883 int (*disable_plane)(struct drm_plane *plane);
884 void (*destroy)(struct drm_plane *plane);
885 void (*reset)(struct drm_plane *plane);
887 int (*set_property)(struct drm_plane *plane,
888 struct drm_property *property, uint64_t val);
890 /* atomic update handling */
891 struct drm_plane_state *(*atomic_duplicate_state)(struct drm_plane *plane);
892 void (*atomic_destroy_state)(struct drm_plane *plane,
893 struct drm_plane_state *state);
894 int (*atomic_set_property)(struct drm_plane *plane,
895 struct drm_plane_state *state,
896 struct drm_property *property,
898 int (*atomic_get_property)(struct drm_plane *plane,
899 const struct drm_plane_state *state,
900 struct drm_property *property,
905 * This optional hook can be used to register additional userspace
906 * interfaces attached to the plane like debugfs interfaces.
907 * It is called late in the driver load sequence from drm_dev_register().
908 * Everything added from this callback should be unregistered in
909 * the early_unregister callback.
913 * 0 on success, or a negative error code on failure.
915 int (*late_register)(struct drm_plane *plane);
920 * This optional hook should be used to unregister the additional
921 * userspace interfaces attached to the plane from
922 * late_unregister(). It is called from drm_dev_unregister(),
923 * early in the driver unload sequence to disable userspace access
924 * before data structures are torndown.
926 void (*early_unregister)(struct drm_plane *plane);
929 enum drm_plane_type {
930 DRM_PLANE_TYPE_OVERLAY,
931 DRM_PLANE_TYPE_PRIMARY,
932 DRM_PLANE_TYPE_CURSOR,
936 * struct drm_plane - central DRM plane control structure
937 * @dev: DRM device this plane belongs to
938 * @parent: this plane share some resources with parent plane.
939 * @head: for list management
940 * @base: base mode object
941 * @possible_crtcs: pipes this plane can be bound to
942 * @format_types: array of formats supported by this plane
943 * @format_count: number of formats supported
944 * @format_default: driver hasn't supplied supported formats for the plane
945 * @crtc: currently bound CRTC
946 * @fb: currently bound fb
947 * @old_fb: Temporary tracking of the old fb while a modeset is ongoing. Used by
948 * drm_mode_set_config_internal() to implement correct refcounting.
949 * @funcs: helper functions
950 * @properties: property tracking for this plane
951 * @type: type of plane (overlay, primary, cursor)
952 * @state: current atomic state for this plane
955 struct drm_device *dev;
956 struct drm_plane *parent;
957 struct list_head head;
959 struct drm_modeset_lock mutex;
961 struct drm_mode_object base;
963 uint32_t possible_crtcs;
964 uint32_t *format_types;
965 unsigned int format_count;
968 struct drm_crtc *crtc;
969 struct drm_framebuffer *fb;
971 struct drm_framebuffer *old_fb;
973 const struct drm_plane_funcs *funcs;
975 struct drm_object_properties properties;
977 enum drm_plane_type type;
979 const void *helper_private;
981 struct drm_plane_state *state;
985 * struct drm_bridge_funcs - drm_bridge control functions
986 * @attach: Called during drm_bridge_attach
987 * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
988 * @disable: Called right before encoder prepare, disables the bridge
989 * @post_disable: Called right after encoder prepare, for lockstepped disable
990 * @mode_set: Set this mode to the bridge
991 * @pre_enable: Called right before encoder commit, for lockstepped commit
992 * @enable: Called right after encoder commit, enables the bridge
994 struct drm_bridge_funcs {
995 int (*attach)(struct drm_bridge *bridge);
996 bool (*mode_fixup)(struct drm_bridge *bridge,
997 const struct drm_display_mode *mode,
998 struct drm_display_mode *adjusted_mode);
999 void (*disable)(struct drm_bridge *bridge);
1000 void (*post_disable)(struct drm_bridge *bridge);
1001 void (*mode_set)(struct drm_bridge *bridge,
1002 struct drm_display_mode *mode,
1003 struct drm_display_mode *adjusted_mode);
1004 void (*pre_enable)(struct drm_bridge *bridge);
1005 void (*enable)(struct drm_bridge *bridge);
1009 * struct drm_bridge - central DRM bridge control structure
1010 * @dev: DRM device this bridge belongs to
1011 * @encoder: encoder to which this bridge is connected
1012 * @next: the next bridge in the encoder chain
1013 * @of_node: device node pointer to the bridge
1014 * @list: to keep track of all added bridges
1015 * @funcs: control functions
1016 * @driver_private: pointer to the bridge driver's internal context
1019 struct drm_device *dev;
1020 struct drm_encoder *encoder;
1021 struct drm_bridge *next;
1023 struct device_node *of_node;
1025 struct list_head list;
1027 const struct drm_bridge_funcs *funcs;
1028 void *driver_private;
1032 * struct drm_atomic_state - the global state object for atomic updates
1033 * @dev: parent DRM device
1034 * @allow_modeset: allow full modeset
1035 * @legacy_cursor_update: hint to enforce legacy cursor ioctl semantics
1036 * @planes: pointer to array of plane pointers
1037 * @plane_states: pointer to array of plane states pointers
1038 * @crtcs: pointer to array of CRTC pointers
1039 * @crtc_states: pointer to array of CRTC states pointers
1040 * @num_connector: size of the @connectors and @connector_states arrays
1041 * @connectors: pointer to array of connector pointers
1042 * @connector_states: pointer to array of connector states pointers
1043 * @acquire_ctx: acquire context for this atomic modeset state update
1045 struct drm_atomic_state {
1046 struct drm_device *dev;
1047 bool allow_modeset : 1;
1048 bool legacy_cursor_update : 1;
1049 struct drm_plane **planes;
1050 struct drm_plane_state **plane_states;
1051 struct drm_crtc **crtcs;
1052 struct drm_crtc_state **crtc_states;
1054 struct drm_connector **connectors;
1055 struct drm_connector_state **connector_states;
1057 struct drm_modeset_acquire_ctx *acquire_ctx;
1062 * struct drm_mode_set - new values for a CRTC config change
1063 * @fb: framebuffer to use for new config
1064 * @crtc: CRTC whose configuration we're about to change
1065 * @mode: mode timings to use
1066 * @x: position of this CRTC relative to @fb
1067 * @y: position of this CRTC relative to @fb
1068 * @connectors: array of connectors to drive with this CRTC if possible
1069 * @num_connectors: size of @connectors array
1071 * Represents a single crtc the connectors that it drives with what mode
1072 * and from which framebuffer it scans out from.
1074 * This is used to set modes.
1076 struct drm_mode_set {
1077 struct drm_framebuffer *fb;
1078 struct drm_crtc *crtc;
1079 struct drm_display_mode *mode;
1084 struct drm_connector **connectors;
1085 size_t num_connectors;
1089 * struct drm_mode_config_funcs - basic driver provided mode setting functions
1090 * @fb_create: create a new framebuffer object
1091 * @output_poll_changed: function to handle output configuration changes
1092 * @atomic_check: check whether a given atomic state update is possible
1093 * @atomic_commit: commit an atomic state update previously verified with
1095 * @atomic_state_alloc: allocate a new atomic state
1096 * @atomic_state_clear: clear the atomic state
1097 * @atomic_state_free: free the atomic state
1099 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
1102 struct drm_mode_config_funcs {
1103 struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
1104 struct drm_file *file_priv,
1105 struct drm_mode_fb_cmd2 *mode_cmd);
1106 void (*output_poll_changed)(struct drm_device *dev);
1108 int (*atomic_check)(struct drm_device *dev,
1109 struct drm_atomic_state *a);
1110 int (*atomic_commit)(struct drm_device *dev,
1111 struct drm_atomic_state *a,
1113 struct drm_atomic_state *(*atomic_state_alloc)(struct drm_device *dev);
1114 void (*atomic_state_clear)(struct drm_atomic_state *state);
1115 void (*atomic_state_free)(struct drm_atomic_state *state);
1119 * struct drm_mode_config - Mode configuration control structure
1120 * @mutex: mutex protecting KMS related lists and structures
1121 * @connection_mutex: ww mutex protecting connector state and routing
1122 * @acquire_ctx: global implicit acquire context used by atomic drivers for
1124 * @idr_mutex: mutex for KMS ID allocation and management
1125 * @crtc_idr: main KMS ID tracking object
1126 * @fb_lock: mutex to protect fb state and lists
1127 * @num_fb: number of fbs available
1128 * @fb_list: list of framebuffers available
1129 * @num_connector: number of connectors on this device
1130 * @connector_list: list of connector objects
1131 * @num_encoder: number of encoders on this device
1132 * @encoder_list: list of encoder objects
1133 * @num_overlay_plane: number of overlay planes on this device
1134 * @num_total_plane: number of universal (i.e. with primary/curso) planes on this device
1135 * @plane_list: list of plane objects
1136 * @num_crtc: number of CRTCs on this device
1137 * @crtc_list: list of CRTC objects
1138 * @property_list: list of property objects
1139 * @min_width: minimum pixel width on this device
1140 * @min_height: minimum pixel height on this device
1141 * @max_width: maximum pixel width on this device
1142 * @max_height: maximum pixel height on this device
1143 * @funcs: core driver provided mode setting functions
1144 * @fb_base: base address of the framebuffer
1145 * @poll_enabled: track polling support for this device
1146 * @poll_running: track polling status for this device
1147 * @output_poll_work: delayed work for polling in process context
1148 * @property_blob_list: list of all the blob property objects
1149 * @blob_lock: mutex for blob property allocation and management
1150 * @*_property: core property tracking
1151 * @preferred_depth: preferred RBG pixel depth, used by fb helpers
1152 * @prefer_shadow: hint to userspace to prefer shadow-fb rendering
1153 * @async_page_flip: does this device support async flips on the primary plane?
1154 * @cursor_width: hint to userspace for max cursor width
1155 * @cursor_height: hint to userspace for max cursor height
1157 * Core mode resource tracking structure. All CRTC, encoders, and connectors
1158 * enumerated by the driver are added here, as are global properties. Some
1159 * global restrictions are also here, e.g. dimension restrictions.
1161 struct drm_mode_config {
1162 struct mutex mutex; /* protects configuration (mode lists etc.) */
1163 struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */
1164 struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */
1165 struct mutex idr_mutex; /* for IDR management */
1166 struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
1167 struct idr tile_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
1168 /* this is limited to one for now */
1170 struct mutex fb_lock; /* proctects global and per-file fb lists */
1172 struct list_head fb_list;
1175 struct list_head connector_list;
1177 struct list_head encoder_list;
1180 * Track # of overlay planes separately from # of total planes. By
1181 * default we only advertise overlay planes to userspace; if userspace
1182 * sets the "universal plane" capability bit, we'll go ahead and
1183 * expose all planes.
1185 int num_overlay_plane;
1186 int num_total_plane;
1187 int num_share_plane;
1188 int num_share_overlay_plane;
1189 struct list_head plane_list;
1192 struct list_head crtc_list;
1194 struct list_head property_list;
1196 int min_width, min_height;
1197 int max_width, max_height;
1198 const struct drm_mode_config_funcs *funcs;
1199 resource_size_t fb_base;
1201 /* output poll support */
1205 struct delayed_work output_poll_work;
1207 struct mutex blob_lock;
1209 /* pointers to share properties */
1210 struct drm_property *prop_share_id;
1211 struct drm_property *prop_share_flags;
1213 /* pointers to standard properties */
1214 struct list_head property_blob_list;
1215 struct drm_property *edid_property;
1216 struct drm_property *dpms_property;
1217 struct drm_property *path_property;
1218 struct drm_property *tile_property;
1219 struct drm_property *plane_type_property;
1220 struct drm_property *rotation_property;
1221 struct drm_property *prop_src_x;
1222 struct drm_property *prop_src_y;
1223 struct drm_property *prop_src_w;
1224 struct drm_property *prop_src_h;
1225 struct drm_property *prop_crtc_x;
1226 struct drm_property *prop_crtc_y;
1227 struct drm_property *prop_crtc_w;
1228 struct drm_property *prop_crtc_h;
1229 struct drm_property *prop_fb_id;
1230 struct drm_property *prop_crtc_id;
1231 struct drm_property *prop_active;
1232 struct drm_property *prop_mode_id;
1234 /* DVI-I properties */
1235 struct drm_property *dvi_i_subconnector_property;
1236 struct drm_property *dvi_i_select_subconnector_property;
1239 struct drm_property *tv_subconnector_property;
1240 struct drm_property *tv_select_subconnector_property;
1241 struct drm_property *tv_mode_property;
1242 struct drm_property *tv_left_margin_property;
1243 struct drm_property *tv_right_margin_property;
1244 struct drm_property *tv_top_margin_property;
1245 struct drm_property *tv_bottom_margin_property;
1246 struct drm_property *tv_brightness_property;
1247 struct drm_property *tv_contrast_property;
1248 struct drm_property *tv_flicker_reduction_property;
1249 struct drm_property *tv_overscan_property;
1250 struct drm_property *tv_saturation_property;
1251 struct drm_property *tv_hue_property;
1253 /* Optional properties */
1254 struct drm_property *scaling_mode_property;
1255 struct drm_property *aspect_ratio_property;
1256 struct drm_property *dirty_info_property;
1258 /* properties for virtual machine layout */
1259 struct drm_property *suggested_x_property;
1260 struct drm_property *suggested_y_property;
1262 /* dumb ioctl parameters */
1263 uint32_t preferred_depth, prefer_shadow;
1265 /* whether async page flip is supported or not */
1266 bool async_page_flip;
1268 /* whether the driver supports fb modifiers */
1269 bool allow_fb_modifiers;
1272 uint32_t cursor_width, cursor_height;
1276 * drm_for_each_plane_mask - iterate over planes specified by bitmask
1277 * @plane: the loop cursor
1278 * @dev: the DRM device
1279 * @plane_mask: bitmask of plane indices
1281 * Iterate over all planes specified by bitmask.
1283 #define drm_for_each_plane_mask(plane, dev, plane_mask) \
1284 list_for_each_entry((plane), &(dev)->mode_config.plane_list, head) \
1285 if ((plane_mask) & (1 << drm_plane_index(plane)))
1288 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
1289 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
1290 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
1291 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
1292 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
1293 #define obj_to_property(x) container_of(x, struct drm_property, base)
1294 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
1295 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
1297 struct drm_prop_enum_list {
1302 extern __printf(6, 7)
1303 int drm_crtc_init_with_planes(struct drm_device *dev,
1304 struct drm_crtc *crtc,
1305 struct drm_plane *primary,
1306 struct drm_plane *cursor,
1307 const struct drm_crtc_funcs *funcs,
1308 const char *name, ...);
1309 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
1310 extern unsigned int drm_crtc_index(struct drm_crtc *crtc);
1313 * drm_crtc_mask - find the mask of a registered CRTC
1314 * @crtc: CRTC to find mask for
1316 * Given a registered CRTC, return the mask bit of that CRTC for an
1317 * encoder's possible_crtcs field.
1319 static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
1321 return 1 << drm_crtc_index(crtc);
1324 extern void drm_connector_ida_init(void);
1325 extern void drm_connector_ida_destroy(void);
1326 extern int drm_connector_init(struct drm_device *dev,
1327 struct drm_connector *connector,
1328 const struct drm_connector_funcs *funcs,
1329 int connector_type);
1330 int drm_connector_register(struct drm_connector *connector);
1331 void drm_connector_unregister(struct drm_connector *connector);
1333 extern void drm_connector_cleanup(struct drm_connector *connector);
1334 extern unsigned int drm_connector_index(struct drm_connector *connector);
1336 /* helpers to {un}register all connectors from sysfs for device */
1337 extern int drm_connector_register_all(struct drm_device *dev);
1338 extern void drm_connector_unregister_all(struct drm_device *dev);
1340 extern int drm_bridge_add(struct drm_bridge *bridge);
1341 extern void drm_bridge_remove(struct drm_bridge *bridge);
1342 extern struct drm_bridge *of_drm_find_bridge(struct device_node *np);
1343 extern int drm_bridge_attach(struct drm_device *dev, struct drm_bridge *bridge);
1345 bool drm_bridge_mode_fixup(struct drm_bridge *bridge,
1346 const struct drm_display_mode *mode,
1347 struct drm_display_mode *adjusted_mode);
1348 void drm_bridge_disable(struct drm_bridge *bridge);
1349 void drm_bridge_post_disable(struct drm_bridge *bridge);
1350 void drm_bridge_mode_set(struct drm_bridge *bridge,
1351 struct drm_display_mode *mode,
1352 struct drm_display_mode *adjusted_mode);
1353 void drm_bridge_pre_enable(struct drm_bridge *bridge);
1354 void drm_bridge_enable(struct drm_bridge *bridge);
1356 extern __printf(5, 6)
1357 int drm_encoder_init(struct drm_device *dev,
1358 struct drm_encoder *encoder,
1359 const struct drm_encoder_funcs *funcs,
1360 int encoder_type, const char *name, ...);
1363 * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
1364 * @encoder: encoder to test
1365 * @crtc: crtc to test
1367 * Return false if @encoder can't be driven by @crtc, true otherwise.
1369 static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
1370 struct drm_crtc *crtc)
1372 return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
1375 extern __printf(8, 9)
1376 int drm_universal_plane_init(struct drm_device *dev,
1377 struct drm_plane *plane,
1378 unsigned long possible_crtcs,
1379 const struct drm_plane_funcs *funcs,
1380 const uint32_t *formats,
1381 unsigned int format_count,
1382 enum drm_plane_type type,
1383 const char *name, ...);
1384 extern int drm_plane_init(struct drm_device *dev,
1385 struct drm_plane *plane,
1386 unsigned long possible_crtcs,
1387 const struct drm_plane_funcs *funcs,
1388 const uint32_t *formats, unsigned int format_count,
1390 extern int drm_share_plane_init(struct drm_device *dev, struct drm_plane *plane,
1391 struct drm_plane *parent,
1392 unsigned long possible_crtcs,
1393 const struct drm_plane_funcs *funcs,
1394 const uint32_t *formats,
1395 unsigned int format_count,
1396 enum drm_plane_type type);
1397 extern void drm_plane_cleanup(struct drm_plane *plane);
1398 extern unsigned int drm_plane_index(struct drm_plane *plane);
1399 extern struct drm_plane * drm_plane_from_index(struct drm_device *dev, int idx);
1400 extern void drm_plane_force_disable(struct drm_plane *plane);
1401 extern int drm_plane_check_pixel_format(const struct drm_plane *plane,
1403 extern void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
1404 int *hdisplay, int *vdisplay);
1405 extern int drm_crtc_check_viewport(const struct drm_crtc *crtc,
1407 const struct drm_display_mode *mode,
1408 const struct drm_framebuffer *fb);
1410 extern void drm_encoder_cleanup(struct drm_encoder *encoder);
1412 extern const char *drm_get_connector_status_name(enum drm_connector_status status);
1413 extern const char *drm_get_subpixel_order_name(enum subpixel_order order);
1414 extern const char *drm_get_dpms_name(int val);
1415 extern const char *drm_get_dvi_i_subconnector_name(int val);
1416 extern const char *drm_get_dvi_i_select_name(int val);
1417 extern const char *drm_get_tv_subconnector_name(int val);
1418 extern const char *drm_get_tv_select_name(int val);
1419 extern void drm_fb_release(struct drm_file *file_priv);
1420 extern void drm_property_destroy_user_blobs(struct drm_device *dev,
1421 struct drm_file *file_priv);
1422 extern bool drm_probe_ddc(struct i2c_adapter *adapter);
1423 extern struct edid *drm_get_edid(struct drm_connector *connector,
1424 struct i2c_adapter *adapter);
1425 extern struct edid *drm_edid_duplicate(const struct edid *edid);
1426 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
1427 extern void drm_mode_config_init(struct drm_device *dev);
1428 extern void drm_mode_config_reset(struct drm_device *dev);
1429 extern void drm_mode_config_cleanup(struct drm_device *dev);
1431 extern int drm_mode_connector_set_path_property(struct drm_connector *connector,
1433 int drm_mode_connector_set_tile_property(struct drm_connector *connector);
1434 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
1435 const struct edid *edid);
1437 extern int drm_display_info_set_bus_formats(struct drm_display_info *info,
1439 unsigned int num_formats);
1441 static inline bool drm_property_type_is(struct drm_property *property,
1444 /* instanceof for props.. handles extended type vs original types: */
1445 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
1446 return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;
1447 return property->flags & type;
1450 static inline bool drm_property_type_valid(struct drm_property *property)
1452 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
1453 return !(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
1454 return !!(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
1457 extern int drm_object_property_set_value(struct drm_mode_object *obj,
1458 struct drm_property *property,
1460 extern int drm_object_property_get_value(struct drm_mode_object *obj,
1461 struct drm_property *property,
1463 extern int drm_framebuffer_init(struct drm_device *dev,
1464 struct drm_framebuffer *fb,
1465 const struct drm_framebuffer_funcs *funcs);
1466 extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
1468 extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
1469 extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
1470 extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
1471 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
1472 extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
1474 extern void drm_object_attach_property(struct drm_mode_object *obj,
1475 struct drm_property *property,
1477 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
1478 const char *name, int num_values);
1479 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
1481 const struct drm_prop_enum_list *props,
1483 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
1484 int flags, const char *name,
1485 const struct drm_prop_enum_list *props,
1487 uint64_t supported_bits);
1488 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
1490 uint64_t min, uint64_t max);
1491 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
1492 int flags, const char *name,
1493 int64_t min, int64_t max);
1494 struct drm_property *drm_property_create_object(struct drm_device *dev,
1495 int flags, const char *name, uint32_t type);
1496 struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags,
1498 struct drm_property_blob *drm_property_create_blob(struct drm_device *dev,
1501 struct drm_property_blob *drm_property_lookup_blob(struct drm_device *dev,
1503 struct drm_property_blob *drm_property_reference_blob(struct drm_property_blob *blob);
1504 void drm_property_unreference_blob(struct drm_property_blob *blob);
1505 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
1506 extern int drm_property_add_enum(struct drm_property *property, int index,
1507 uint64_t value, const char *name);
1508 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1509 extern int drm_mode_create_tv_properties(struct drm_device *dev,
1510 unsigned int num_modes,
1511 const char * const modes[]);
1512 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1513 extern int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1514 extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
1515 extern int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
1516 extern bool drm_property_change_valid_get(struct drm_property *property,
1517 uint64_t value, struct drm_mode_object **ref);
1518 extern void drm_property_change_valid_put(struct drm_property *property,
1519 struct drm_mode_object *ref);
1521 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
1522 struct drm_encoder *encoder);
1523 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
1525 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
1526 uint32_t id, uint32_t type);
1529 extern int drm_mode_getresources(struct drm_device *dev,
1530 void *data, struct drm_file *file_priv);
1531 extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
1532 struct drm_file *file_priv);
1533 extern int drm_mode_getcrtc(struct drm_device *dev,
1534 void *data, struct drm_file *file_priv);
1535 extern int drm_mode_getconnector(struct drm_device *dev,
1536 void *data, struct drm_file *file_priv);
1537 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
1538 extern int drm_mode_setcrtc(struct drm_device *dev,
1539 void *data, struct drm_file *file_priv);
1540 extern int drm_mode_getplane(struct drm_device *dev,
1541 void *data, struct drm_file *file_priv);
1542 extern int drm_mode_setplane(struct drm_device *dev,
1543 void *data, struct drm_file *file_priv);
1544 extern int drm_mode_cursor_ioctl(struct drm_device *dev,
1545 void *data, struct drm_file *file_priv);
1546 extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
1547 void *data, struct drm_file *file_priv);
1548 extern int drm_mode_addfb(struct drm_device *dev,
1549 void *data, struct drm_file *file_priv);
1550 extern int drm_mode_addfb2(struct drm_device *dev,
1551 void *data, struct drm_file *file_priv);
1552 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
1553 extern int drm_mode_rmfb(struct drm_device *dev,
1554 void *data, struct drm_file *file_priv);
1555 extern int drm_mode_getfb(struct drm_device *dev,
1556 void *data, struct drm_file *file_priv);
1557 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1558 void *data, struct drm_file *file_priv);
1560 extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1561 void *data, struct drm_file *file_priv);
1562 extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1563 void *data, struct drm_file *file_priv);
1564 extern int drm_mode_createblob_ioctl(struct drm_device *dev,
1565 void *data, struct drm_file *file_priv);
1566 extern int drm_mode_destroyblob_ioctl(struct drm_device *dev,
1567 void *data, struct drm_file *file_priv);
1568 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1569 void *data, struct drm_file *file_priv);
1570 extern int drm_mode_getencoder(struct drm_device *dev,
1571 void *data, struct drm_file *file_priv);
1572 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1573 void *data, struct drm_file *file_priv);
1574 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1575 void *data, struct drm_file *file_priv);
1576 extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
1577 extern enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code);
1578 extern bool drm_detect_hdmi_monitor(struct edid *edid);
1579 extern bool drm_detect_monitor_audio(struct edid *edid);
1580 extern bool drm_rgb_quant_range_selectable(struct edid *edid);
1581 extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1582 void *data, struct drm_file *file_priv);
1583 extern int drm_add_modes_noedid(struct drm_connector *connector,
1584 int hdisplay, int vdisplay);
1585 extern void drm_set_preferred_mode(struct drm_connector *connector,
1586 int hpref, int vpref);
1588 extern int drm_edid_header_is_valid(const u8 *raw_edid);
1589 extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid,
1590 bool *edid_corrupt);
1591 extern bool drm_edid_is_valid(struct edid *edid);
1593 extern struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1595 extern struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1597 extern void drm_mode_put_tile_group(struct drm_device *dev,
1598 struct drm_tile_group *tg);
1599 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
1600 int hsize, int vsize, int fresh,
1603 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1604 void *data, struct drm_file *file_priv);
1605 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1606 void *data, struct drm_file *file_priv);
1607 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1608 void *data, struct drm_file *file_priv);
1609 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1610 struct drm_file *file_priv);
1611 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1612 struct drm_file *file_priv);
1613 extern int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
1614 struct drm_property *property,
1616 extern int drm_mode_atomic_ioctl(struct drm_device *dev,
1617 void *data, struct drm_file *file_priv);
1619 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1621 extern int drm_format_num_planes(uint32_t format);
1622 extern int drm_format_plane_bpp(uint32_t format, int plane);
1623 extern int drm_format_plane_cpp(uint32_t format, int plane);
1624 extern int drm_format_horz_chroma_subsampling(uint32_t format);
1625 extern int drm_format_vert_chroma_subsampling(uint32_t format);
1626 extern const char *drm_get_format_name(uint32_t format);
1627 extern struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
1628 unsigned int supported_rotations);
1629 extern unsigned int drm_rotation_simplify(unsigned int rotation,
1630 unsigned int supported_rotations);
1634 static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
1637 struct drm_mode_object *mo;
1638 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE);
1639 return mo ? obj_to_plane(mo) : NULL;
1642 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1645 struct drm_mode_object *mo;
1646 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1647 return mo ? obj_to_crtc(mo) : NULL;
1650 static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
1653 struct drm_mode_object *mo;
1654 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
1655 return mo ? obj_to_encoder(mo) : NULL;
1658 static inline struct drm_connector *drm_connector_find(struct drm_device *dev,
1661 struct drm_mode_object *mo;
1662 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR);
1663 return mo ? obj_to_connector(mo) : NULL;
1666 static inline struct drm_property *drm_property_find(struct drm_device *dev,
1669 struct drm_mode_object *mo;
1670 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY);
1671 return mo ? obj_to_property(mo) : NULL;
1674 /* Plane list iterator for legacy (overlay only) planes. */
1675 #define drm_for_each_legacy_plane(plane, dev) \
1676 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) \
1677 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1679 #define drm_for_each_plane(plane, dev) \
1680 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head)
1682 #define drm_for_each_crtc(crtc, dev) \
1683 list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)
1686 assert_drm_connector_list_read_locked(struct drm_mode_config *mode_config)
1689 * The connector hotadd/remove code currently grabs both locks when
1690 * updating lists. Hence readers need only hold either of them to be
1691 * safe and the check amounts to
1693 * WARN_ON(not_holding(A) && not_holding(B)).
1695 WARN_ON(!mutex_is_locked(&mode_config->mutex) &&
1696 !drm_modeset_is_locked(&mode_config->connection_mutex));
1699 #define drm_for_each_connector(connector, dev) \
1700 for (assert_drm_connector_list_read_locked(&(dev)->mode_config), \
1701 connector = list_first_entry(&(dev)->mode_config.connector_list, \
1702 struct drm_connector, head); \
1703 &connector->head != (&(dev)->mode_config.connector_list); \
1704 connector = list_next_entry(connector, head))
1706 #define drm_for_each_encoder(encoder, dev) \
1707 list_for_each_entry(encoder, &(dev)->mode_config.encoder_list, head)
1709 #define drm_for_each_fb(fb, dev) \
1710 for (WARN_ON(!mutex_is_locked(&(dev)->mode_config.fb_lock)), \
1711 fb = list_first_entry(&(dev)->mode_config.fb_list, \
1712 struct drm_framebuffer, head); \
1713 &fb->head != (&(dev)->mode_config.fb_list); \
1714 fb = list_next_entry(fb, head))
1716 #endif /* __DRM_CRTC_H__ */