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 * @max_tmds_char: indicates the maximum TMDS Character Rate supported
729 * @scdc_present: when set the sink supports SCDC functionality
730 * @rr_capable: when set the sink is capable of initiating an SCDC read request
731 * @lte_340mcsc_scramble: when set the sink supports less than 340Mcsc scramble
732 * @flags_3d: 3D view(s) supported by the sink, see drm_edid.h (DRM_EDID_3D_*)
733 * @edid_corrupt: indicates whether the last read EDID was corrupt
734 * @debugfs_entry: debugfs directory for this connector
735 * @state: current atomic state for this connector
736 * @has_tile: is this connector connected to a tiled monitor
737 * @tile_group: tile group for the connected monitor
738 * @tile_is_single_monitor: whether the tile is one monitor housing
739 * @num_h_tile: number of horizontal tiles in the tile group
740 * @num_v_tile: number of vertical tiles in the tile group
741 * @tile_h_loc: horizontal location of this tile
742 * @tile_v_loc: vertical location of this tile
743 * @tile_h_size: horizontal size of this tile.
744 * @tile_v_size: vertical size of this tile.
746 * Each connector may be connected to one or more CRTCs, or may be clonable by
747 * another connector if they can share a CRTC. Each connector also has a specific
748 * position in the broader display (referred to as a 'screen' though it could
749 * span multiple monitors).
751 struct drm_connector {
752 struct drm_device *dev;
753 struct device_node *port;
755 struct device_attribute *attr;
756 struct list_head head;
758 struct drm_mode_object base;
762 int connector_type_id;
763 bool interlace_allowed;
764 bool doublescan_allowed;
766 struct list_head modes; /* list of modes on this connector */
768 enum drm_connector_status status;
770 /* these are modes added by probing with DDC or the BIOS */
771 struct list_head probed_modes;
773 struct drm_display_info display_info;
774 const struct drm_connector_funcs *funcs;
776 struct drm_property_blob *edid_blob_ptr;
777 struct drm_object_properties properties;
779 struct drm_property_blob *path_blob_ptr;
781 struct drm_property_blob *tile_blob_ptr;
783 uint8_t polled; /* DRM_CONNECTOR_POLL_* */
785 /* requested DPMS state */
788 const void *helper_private;
790 /* forced on connector */
791 struct drm_cmdline_mode cmdline_mode;
792 enum drm_connector_force force;
794 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
795 struct drm_encoder *encoder; /* currently active encoder */
799 uint8_t eld[MAX_ELD_BYTES];
801 int max_tmds_clock; /* in MHz */
802 bool latency_present[2];
803 int video_latency[2]; /* [0]: progressive, [1]: interlaced */
804 int audio_latency[2];
805 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
806 unsigned bad_edid_counter;
808 /* EDID bits HDMI 2.0 */
809 int max_tmds_char; /* in Mcsc */
812 bool lte_340mcsc_scramble;
815 /* Flag for raw EDID header corruption - used in Displayport
816 * compliance testing - * Displayport Link CTS Core 1.2 rev1.1 4.2.2.6
820 struct dentry *debugfs_entry;
822 struct drm_connector_state *state;
826 struct drm_tile_group *tile_group;
827 bool tile_is_single_monitor;
829 uint8_t num_h_tile, num_v_tile;
830 uint8_t tile_h_loc, tile_v_loc;
831 uint16_t tile_h_size, tile_v_size;
835 * struct drm_plane_state - mutable plane state
836 * @plane: backpointer to the plane
837 * @crtc: currently bound CRTC, NULL if disabled
838 * @fb: currently bound framebuffer
839 * @fence: optional fence to wait for before scanning out @fb
840 * @crtc_x: left position of visible portion of plane on crtc
841 * @crtc_y: upper position of visible portion of plane on crtc
842 * @crtc_w: width of visible portion of plane on crtc
843 * @crtc_h: height of visible portion of plane on crtc
844 * @src_x: left position of visible portion of plane within
846 * @src_y: upper position of visible portion of plane within
848 * @src_w: width of visible portion of plane (in 16.16)
849 * @src_h: height of visible portion of plane (in 16.16)
850 * @state: backpointer to global drm_atomic_state
852 struct drm_plane_state {
853 struct drm_plane *plane;
855 struct drm_crtc *crtc; /* do not write directly, use drm_atomic_set_crtc_for_plane() */
856 struct drm_framebuffer *fb; /* do not write directly, use drm_atomic_set_fb_for_plane() */
859 /* Signed dest location allows it to be partially off screen */
860 int32_t crtc_x, crtc_y;
861 uint32_t crtc_w, crtc_h;
863 /* Source values are 16.16 fixed point */
864 uint32_t src_x, src_y;
865 uint32_t src_h, src_w;
868 unsigned int rotation;
870 struct drm_atomic_state *state;
875 * struct drm_plane_funcs - driver plane control functions
876 * @update_plane: update the plane configuration
877 * @disable_plane: shut down the plane
878 * @destroy: clean up plane resources
879 * @reset: reset plane after state has been invalidated (e.g. resume)
880 * @set_property: called when a property is changed
881 * @atomic_duplicate_state: duplicate the atomic state for this plane
882 * @atomic_destroy_state: destroy an atomic state for this plane
883 * @atomic_set_property: set a property on an atomic state for this plane
884 * (do not call directly, use drm_atomic_plane_set_property())
885 * @atomic_get_property: get a property on an atomic state for this plane
886 * (do not call directly, use drm_atomic_plane_get_property())
888 struct drm_plane_funcs {
889 int (*update_plane)(struct drm_plane *plane,
890 struct drm_crtc *crtc, struct drm_framebuffer *fb,
891 int crtc_x, int crtc_y,
892 unsigned int crtc_w, unsigned int crtc_h,
893 uint32_t src_x, uint32_t src_y,
894 uint32_t src_w, uint32_t src_h);
895 int (*disable_plane)(struct drm_plane *plane);
896 void (*destroy)(struct drm_plane *plane);
897 void (*reset)(struct drm_plane *plane);
899 int (*set_property)(struct drm_plane *plane,
900 struct drm_property *property, uint64_t val);
902 /* atomic update handling */
903 struct drm_plane_state *(*atomic_duplicate_state)(struct drm_plane *plane);
904 void (*atomic_destroy_state)(struct drm_plane *plane,
905 struct drm_plane_state *state);
906 int (*atomic_set_property)(struct drm_plane *plane,
907 struct drm_plane_state *state,
908 struct drm_property *property,
910 int (*atomic_get_property)(struct drm_plane *plane,
911 const struct drm_plane_state *state,
912 struct drm_property *property,
917 * This optional hook can be used to register additional userspace
918 * interfaces attached to the plane like debugfs interfaces.
919 * It is called late in the driver load sequence from drm_dev_register().
920 * Everything added from this callback should be unregistered in
921 * the early_unregister callback.
925 * 0 on success, or a negative error code on failure.
927 int (*late_register)(struct drm_plane *plane);
932 * This optional hook should be used to unregister the additional
933 * userspace interfaces attached to the plane from
934 * late_unregister(). It is called from drm_dev_unregister(),
935 * early in the driver unload sequence to disable userspace access
936 * before data structures are torndown.
938 void (*early_unregister)(struct drm_plane *plane);
941 enum drm_plane_type {
942 DRM_PLANE_TYPE_OVERLAY,
943 DRM_PLANE_TYPE_PRIMARY,
944 DRM_PLANE_TYPE_CURSOR,
948 * struct drm_plane - central DRM plane control structure
949 * @dev: DRM device this plane belongs to
950 * @parent: this plane share some resources with parent plane.
951 * @head: for list management
952 * @base: base mode object
953 * @possible_crtcs: pipes this plane can be bound to
954 * @format_types: array of formats supported by this plane
955 * @format_count: number of formats supported
956 * @format_default: driver hasn't supplied supported formats for the plane
957 * @crtc: currently bound CRTC
958 * @fb: currently bound fb
959 * @old_fb: Temporary tracking of the old fb while a modeset is ongoing. Used by
960 * drm_mode_set_config_internal() to implement correct refcounting.
961 * @funcs: helper functions
962 * @properties: property tracking for this plane
963 * @type: type of plane (overlay, primary, cursor)
964 * @state: current atomic state for this plane
967 struct drm_device *dev;
968 struct drm_plane *parent;
969 struct list_head head;
971 struct drm_modeset_lock mutex;
973 struct drm_mode_object base;
975 uint32_t possible_crtcs;
976 uint32_t *format_types;
977 unsigned int format_count;
980 struct drm_crtc *crtc;
981 struct drm_framebuffer *fb;
983 struct drm_framebuffer *old_fb;
985 const struct drm_plane_funcs *funcs;
987 struct drm_object_properties properties;
989 enum drm_plane_type type;
991 const void *helper_private;
993 struct drm_plane_state *state;
997 * struct drm_bridge_funcs - drm_bridge control functions
998 * @attach: Called during drm_bridge_attach
999 * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
1000 * @disable: Called right before encoder prepare, disables the bridge
1001 * @post_disable: Called right after encoder prepare, for lockstepped disable
1002 * @mode_set: Set this mode to the bridge
1003 * @pre_enable: Called right before encoder commit, for lockstepped commit
1004 * @enable: Called right after encoder commit, enables the bridge
1006 struct drm_bridge_funcs {
1007 int (*attach)(struct drm_bridge *bridge);
1008 bool (*mode_fixup)(struct drm_bridge *bridge,
1009 const struct drm_display_mode *mode,
1010 struct drm_display_mode *adjusted_mode);
1011 void (*disable)(struct drm_bridge *bridge);
1012 void (*post_disable)(struct drm_bridge *bridge);
1013 void (*mode_set)(struct drm_bridge *bridge,
1014 struct drm_display_mode *mode,
1015 struct drm_display_mode *adjusted_mode);
1016 void (*pre_enable)(struct drm_bridge *bridge);
1017 void (*enable)(struct drm_bridge *bridge);
1021 * struct drm_bridge - central DRM bridge control structure
1022 * @dev: DRM device this bridge belongs to
1023 * @encoder: encoder to which this bridge is connected
1024 * @next: the next bridge in the encoder chain
1025 * @of_node: device node pointer to the bridge
1026 * @list: to keep track of all added bridges
1027 * @funcs: control functions
1028 * @driver_private: pointer to the bridge driver's internal context
1031 struct drm_device *dev;
1032 struct drm_encoder *encoder;
1033 struct drm_bridge *next;
1035 struct device_node *of_node;
1037 struct list_head list;
1039 const struct drm_bridge_funcs *funcs;
1040 void *driver_private;
1044 * struct drm_atomic_state - the global state object for atomic updates
1045 * @dev: parent DRM device
1046 * @allow_modeset: allow full modeset
1047 * @legacy_cursor_update: hint to enforce legacy cursor ioctl semantics
1048 * @planes: pointer to array of plane pointers
1049 * @plane_states: pointer to array of plane states pointers
1050 * @crtcs: pointer to array of CRTC pointers
1051 * @crtc_states: pointer to array of CRTC states pointers
1052 * @num_connector: size of the @connectors and @connector_states arrays
1053 * @connectors: pointer to array of connector pointers
1054 * @connector_states: pointer to array of connector states pointers
1055 * @acquire_ctx: acquire context for this atomic modeset state update
1057 struct drm_atomic_state {
1058 struct drm_device *dev;
1059 bool allow_modeset : 1;
1060 bool legacy_cursor_update : 1;
1061 struct drm_plane **planes;
1062 struct drm_plane_state **plane_states;
1063 struct drm_crtc **crtcs;
1064 struct drm_crtc_state **crtc_states;
1066 struct drm_connector **connectors;
1067 struct drm_connector_state **connector_states;
1069 struct drm_modeset_acquire_ctx *acquire_ctx;
1074 * struct drm_mode_set - new values for a CRTC config change
1075 * @fb: framebuffer to use for new config
1076 * @crtc: CRTC whose configuration we're about to change
1077 * @mode: mode timings to use
1078 * @x: position of this CRTC relative to @fb
1079 * @y: position of this CRTC relative to @fb
1080 * @connectors: array of connectors to drive with this CRTC if possible
1081 * @num_connectors: size of @connectors array
1083 * Represents a single crtc the connectors that it drives with what mode
1084 * and from which framebuffer it scans out from.
1086 * This is used to set modes.
1088 struct drm_mode_set {
1089 struct drm_framebuffer *fb;
1090 struct drm_crtc *crtc;
1091 struct drm_display_mode *mode;
1096 struct drm_connector **connectors;
1097 size_t num_connectors;
1101 * struct drm_mode_config_funcs - basic driver provided mode setting functions
1102 * @fb_create: create a new framebuffer object
1103 * @output_poll_changed: function to handle output configuration changes
1104 * @atomic_check: check whether a given atomic state update is possible
1105 * @atomic_commit: commit an atomic state update previously verified with
1107 * @atomic_state_alloc: allocate a new atomic state
1108 * @atomic_state_clear: clear the atomic state
1109 * @atomic_state_free: free the atomic state
1111 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
1114 struct drm_mode_config_funcs {
1115 struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
1116 struct drm_file *file_priv,
1117 struct drm_mode_fb_cmd2 *mode_cmd);
1118 void (*output_poll_changed)(struct drm_device *dev);
1120 int (*atomic_check)(struct drm_device *dev,
1121 struct drm_atomic_state *a);
1122 int (*atomic_commit)(struct drm_device *dev,
1123 struct drm_atomic_state *a,
1125 struct drm_atomic_state *(*atomic_state_alloc)(struct drm_device *dev);
1126 void (*atomic_state_clear)(struct drm_atomic_state *state);
1127 void (*atomic_state_free)(struct drm_atomic_state *state);
1131 * struct drm_mode_config - Mode configuration control structure
1132 * @mutex: mutex protecting KMS related lists and structures
1133 * @connection_mutex: ww mutex protecting connector state and routing
1134 * @acquire_ctx: global implicit acquire context used by atomic drivers for
1136 * @idr_mutex: mutex for KMS ID allocation and management
1137 * @crtc_idr: main KMS ID tracking object
1138 * @fb_lock: mutex to protect fb state and lists
1139 * @num_fb: number of fbs available
1140 * @fb_list: list of framebuffers available
1141 * @num_connector: number of connectors on this device
1142 * @connector_list: list of connector objects
1143 * @num_encoder: number of encoders on this device
1144 * @encoder_list: list of encoder objects
1145 * @num_overlay_plane: number of overlay planes on this device
1146 * @num_total_plane: number of universal (i.e. with primary/curso) planes on this device
1147 * @plane_list: list of plane objects
1148 * @num_crtc: number of CRTCs on this device
1149 * @crtc_list: list of CRTC objects
1150 * @property_list: list of property objects
1151 * @min_width: minimum pixel width on this device
1152 * @min_height: minimum pixel height on this device
1153 * @max_width: maximum pixel width on this device
1154 * @max_height: maximum pixel height on this device
1155 * @funcs: core driver provided mode setting functions
1156 * @fb_base: base address of the framebuffer
1157 * @poll_enabled: track polling support for this device
1158 * @poll_running: track polling status for this device
1159 * @output_poll_work: delayed work for polling in process context
1160 * @property_blob_list: list of all the blob property objects
1161 * @blob_lock: mutex for blob property allocation and management
1162 * @*_property: core property tracking
1163 * @preferred_depth: preferred RBG pixel depth, used by fb helpers
1164 * @prefer_shadow: hint to userspace to prefer shadow-fb rendering
1165 * @async_page_flip: does this device support async flips on the primary plane?
1166 * @cursor_width: hint to userspace for max cursor width
1167 * @cursor_height: hint to userspace for max cursor height
1169 * Core mode resource tracking structure. All CRTC, encoders, and connectors
1170 * enumerated by the driver are added here, as are global properties. Some
1171 * global restrictions are also here, e.g. dimension restrictions.
1173 struct drm_mode_config {
1174 struct mutex mutex; /* protects configuration (mode lists etc.) */
1175 struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */
1176 struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */
1177 struct mutex idr_mutex; /* for IDR management */
1178 struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
1179 struct idr tile_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
1180 /* this is limited to one for now */
1182 struct mutex fb_lock; /* proctects global and per-file fb lists */
1184 struct list_head fb_list;
1187 struct list_head connector_list;
1189 struct list_head encoder_list;
1192 * Track # of overlay planes separately from # of total planes. By
1193 * default we only advertise overlay planes to userspace; if userspace
1194 * sets the "universal plane" capability bit, we'll go ahead and
1195 * expose all planes.
1197 int num_overlay_plane;
1198 int num_total_plane;
1199 int num_share_plane;
1200 int num_share_overlay_plane;
1201 struct list_head plane_list;
1204 struct list_head crtc_list;
1206 struct list_head property_list;
1208 int min_width, min_height;
1209 int max_width, max_height;
1210 const struct drm_mode_config_funcs *funcs;
1211 resource_size_t fb_base;
1213 /* output poll support */
1217 struct delayed_work output_poll_work;
1219 struct mutex blob_lock;
1221 /* pointers to share properties */
1222 struct drm_property *prop_share_id;
1223 struct drm_property *prop_share_flags;
1225 /* pointers to standard properties */
1226 struct list_head property_blob_list;
1227 struct drm_property *edid_property;
1228 struct drm_property *dpms_property;
1229 struct drm_property *path_property;
1230 struct drm_property *tile_property;
1231 struct drm_property *plane_type_property;
1232 struct drm_property *rotation_property;
1233 struct drm_property *prop_src_x;
1234 struct drm_property *prop_src_y;
1235 struct drm_property *prop_src_w;
1236 struct drm_property *prop_src_h;
1237 struct drm_property *prop_crtc_x;
1238 struct drm_property *prop_crtc_y;
1239 struct drm_property *prop_crtc_w;
1240 struct drm_property *prop_crtc_h;
1241 struct drm_property *prop_fb_id;
1242 struct drm_property *prop_crtc_id;
1243 struct drm_property *prop_active;
1244 struct drm_property *prop_mode_id;
1246 /* DVI-I properties */
1247 struct drm_property *dvi_i_subconnector_property;
1248 struct drm_property *dvi_i_select_subconnector_property;
1251 struct drm_property *tv_subconnector_property;
1252 struct drm_property *tv_select_subconnector_property;
1253 struct drm_property *tv_mode_property;
1254 struct drm_property *tv_left_margin_property;
1255 struct drm_property *tv_right_margin_property;
1256 struct drm_property *tv_top_margin_property;
1257 struct drm_property *tv_bottom_margin_property;
1258 struct drm_property *tv_brightness_property;
1259 struct drm_property *tv_contrast_property;
1260 struct drm_property *tv_flicker_reduction_property;
1261 struct drm_property *tv_overscan_property;
1262 struct drm_property *tv_saturation_property;
1263 struct drm_property *tv_hue_property;
1265 /* Optional properties */
1266 struct drm_property *scaling_mode_property;
1267 struct drm_property *aspect_ratio_property;
1268 struct drm_property *dirty_info_property;
1270 /* properties for virtual machine layout */
1271 struct drm_property *suggested_x_property;
1272 struct drm_property *suggested_y_property;
1274 /* dumb ioctl parameters */
1275 uint32_t preferred_depth, prefer_shadow;
1277 /* whether async page flip is supported or not */
1278 bool async_page_flip;
1280 /* whether the driver supports fb modifiers */
1281 bool allow_fb_modifiers;
1284 uint32_t cursor_width, cursor_height;
1288 * drm_for_each_plane_mask - iterate over planes specified by bitmask
1289 * @plane: the loop cursor
1290 * @dev: the DRM device
1291 * @plane_mask: bitmask of plane indices
1293 * Iterate over all planes specified by bitmask.
1295 #define drm_for_each_plane_mask(plane, dev, plane_mask) \
1296 list_for_each_entry((plane), &(dev)->mode_config.plane_list, head) \
1297 if ((plane_mask) & (1 << drm_plane_index(plane)))
1300 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
1301 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
1302 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
1303 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
1304 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
1305 #define obj_to_property(x) container_of(x, struct drm_property, base)
1306 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
1307 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
1309 struct drm_prop_enum_list {
1314 extern __printf(6, 7)
1315 int drm_crtc_init_with_planes(struct drm_device *dev,
1316 struct drm_crtc *crtc,
1317 struct drm_plane *primary,
1318 struct drm_plane *cursor,
1319 const struct drm_crtc_funcs *funcs,
1320 const char *name, ...);
1321 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
1322 extern unsigned int drm_crtc_index(struct drm_crtc *crtc);
1325 * drm_crtc_mask - find the mask of a registered CRTC
1326 * @crtc: CRTC to find mask for
1328 * Given a registered CRTC, return the mask bit of that CRTC for an
1329 * encoder's possible_crtcs field.
1331 static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
1333 return 1 << drm_crtc_index(crtc);
1336 extern void drm_connector_ida_init(void);
1337 extern void drm_connector_ida_destroy(void);
1338 extern int drm_connector_init(struct drm_device *dev,
1339 struct drm_connector *connector,
1340 const struct drm_connector_funcs *funcs,
1341 int connector_type);
1342 int drm_connector_register(struct drm_connector *connector);
1343 void drm_connector_unregister(struct drm_connector *connector);
1345 extern void drm_connector_cleanup(struct drm_connector *connector);
1346 extern unsigned int drm_connector_index(struct drm_connector *connector);
1348 /* helpers to {un}register all connectors from sysfs for device */
1349 extern int drm_connector_register_all(struct drm_device *dev);
1350 extern void drm_connector_unregister_all(struct drm_device *dev);
1352 extern int drm_bridge_add(struct drm_bridge *bridge);
1353 extern void drm_bridge_remove(struct drm_bridge *bridge);
1354 extern struct drm_bridge *of_drm_find_bridge(struct device_node *np);
1355 extern int drm_bridge_attach(struct drm_device *dev, struct drm_bridge *bridge);
1357 bool drm_bridge_mode_fixup(struct drm_bridge *bridge,
1358 const struct drm_display_mode *mode,
1359 struct drm_display_mode *adjusted_mode);
1360 void drm_bridge_disable(struct drm_bridge *bridge);
1361 void drm_bridge_post_disable(struct drm_bridge *bridge);
1362 void drm_bridge_mode_set(struct drm_bridge *bridge,
1363 struct drm_display_mode *mode,
1364 struct drm_display_mode *adjusted_mode);
1365 void drm_bridge_pre_enable(struct drm_bridge *bridge);
1366 void drm_bridge_enable(struct drm_bridge *bridge);
1368 extern __printf(5, 6)
1369 int drm_encoder_init(struct drm_device *dev,
1370 struct drm_encoder *encoder,
1371 const struct drm_encoder_funcs *funcs,
1372 int encoder_type, const char *name, ...);
1375 * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
1376 * @encoder: encoder to test
1377 * @crtc: crtc to test
1379 * Return false if @encoder can't be driven by @crtc, true otherwise.
1381 static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
1382 struct drm_crtc *crtc)
1384 return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
1387 extern __printf(8, 9)
1388 int drm_universal_plane_init(struct drm_device *dev,
1389 struct drm_plane *plane,
1390 unsigned long possible_crtcs,
1391 const struct drm_plane_funcs *funcs,
1392 const uint32_t *formats,
1393 unsigned int format_count,
1394 enum drm_plane_type type,
1395 const char *name, ...);
1396 extern int drm_plane_init(struct drm_device *dev,
1397 struct drm_plane *plane,
1398 unsigned long possible_crtcs,
1399 const struct drm_plane_funcs *funcs,
1400 const uint32_t *formats, unsigned int format_count,
1402 extern int drm_share_plane_init(struct drm_device *dev, struct drm_plane *plane,
1403 struct drm_plane *parent,
1404 unsigned long possible_crtcs,
1405 const struct drm_plane_funcs *funcs,
1406 const uint32_t *formats,
1407 unsigned int format_count,
1408 enum drm_plane_type type);
1409 extern void drm_plane_cleanup(struct drm_plane *plane);
1410 extern unsigned int drm_plane_index(struct drm_plane *plane);
1411 extern struct drm_plane * drm_plane_from_index(struct drm_device *dev, int idx);
1412 extern void drm_plane_force_disable(struct drm_plane *plane);
1413 extern int drm_plane_check_pixel_format(const struct drm_plane *plane,
1415 extern void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
1416 int *hdisplay, int *vdisplay);
1417 extern int drm_crtc_check_viewport(const struct drm_crtc *crtc,
1419 const struct drm_display_mode *mode,
1420 const struct drm_framebuffer *fb);
1422 extern void drm_encoder_cleanup(struct drm_encoder *encoder);
1424 extern const char *drm_get_connector_status_name(enum drm_connector_status status);
1425 extern const char *drm_get_subpixel_order_name(enum subpixel_order order);
1426 extern const char *drm_get_dpms_name(int val);
1427 extern const char *drm_get_dvi_i_subconnector_name(int val);
1428 extern const char *drm_get_dvi_i_select_name(int val);
1429 extern const char *drm_get_tv_subconnector_name(int val);
1430 extern const char *drm_get_tv_select_name(int val);
1431 extern const char *drm_get_connector_name(int val);
1432 extern void drm_fb_release(struct drm_file *file_priv);
1433 extern void drm_property_destroy_user_blobs(struct drm_device *dev,
1434 struct drm_file *file_priv);
1435 extern bool drm_probe_ddc(struct i2c_adapter *adapter);
1436 extern struct edid *drm_get_edid(struct drm_connector *connector,
1437 struct i2c_adapter *adapter);
1438 extern struct edid *drm_edid_duplicate(const struct edid *edid);
1439 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
1440 extern void drm_mode_config_init(struct drm_device *dev);
1441 extern void drm_mode_config_reset(struct drm_device *dev);
1442 extern void drm_mode_config_cleanup(struct drm_device *dev);
1444 extern int drm_mode_connector_set_path_property(struct drm_connector *connector,
1446 int drm_mode_connector_set_tile_property(struct drm_connector *connector);
1447 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
1448 const struct edid *edid);
1450 extern int drm_display_info_set_bus_formats(struct drm_display_info *info,
1452 unsigned int num_formats);
1454 static inline bool drm_property_type_is(struct drm_property *property,
1457 /* instanceof for props.. handles extended type vs original types: */
1458 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
1459 return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;
1460 return property->flags & type;
1463 static inline bool drm_property_type_valid(struct drm_property *property)
1465 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
1466 return !(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
1467 return !!(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
1470 extern int drm_object_property_set_value(struct drm_mode_object *obj,
1471 struct drm_property *property,
1473 extern int drm_object_property_get_value(struct drm_mode_object *obj,
1474 struct drm_property *property,
1476 extern int drm_framebuffer_init(struct drm_device *dev,
1477 struct drm_framebuffer *fb,
1478 const struct drm_framebuffer_funcs *funcs);
1479 extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
1481 extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
1482 extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
1483 extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
1484 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
1485 extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
1487 extern void drm_object_attach_property(struct drm_mode_object *obj,
1488 struct drm_property *property,
1490 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
1491 const char *name, int num_values);
1492 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
1494 const struct drm_prop_enum_list *props,
1496 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
1497 int flags, const char *name,
1498 const struct drm_prop_enum_list *props,
1500 uint64_t supported_bits);
1501 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
1503 uint64_t min, uint64_t max);
1504 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
1505 int flags, const char *name,
1506 int64_t min, int64_t max);
1507 struct drm_property *drm_property_create_object(struct drm_device *dev,
1508 int flags, const char *name, uint32_t type);
1509 struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags,
1511 struct drm_property_blob *drm_property_create_blob(struct drm_device *dev,
1514 struct drm_property_blob *drm_property_lookup_blob(struct drm_device *dev,
1516 struct drm_property_blob *drm_property_reference_blob(struct drm_property_blob *blob);
1517 void drm_property_unreference_blob(struct drm_property_blob *blob);
1518 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
1519 extern int drm_property_add_enum(struct drm_property *property, int index,
1520 uint64_t value, const char *name);
1521 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1522 extern int drm_mode_create_tv_properties(struct drm_device *dev,
1523 unsigned int num_modes,
1524 const char * const modes[]);
1525 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1526 extern int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1527 extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
1528 extern int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
1529 extern bool drm_property_change_valid_get(struct drm_property *property,
1530 uint64_t value, struct drm_mode_object **ref);
1531 extern void drm_property_change_valid_put(struct drm_property *property,
1532 struct drm_mode_object *ref);
1534 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
1535 struct drm_encoder *encoder);
1536 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
1538 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
1539 uint32_t id, uint32_t type);
1542 extern int drm_mode_getresources(struct drm_device *dev,
1543 void *data, struct drm_file *file_priv);
1544 extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
1545 struct drm_file *file_priv);
1546 extern int drm_mode_getcrtc(struct drm_device *dev,
1547 void *data, struct drm_file *file_priv);
1548 extern int drm_mode_getconnector(struct drm_device *dev,
1549 void *data, struct drm_file *file_priv);
1550 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
1551 extern int drm_mode_setcrtc(struct drm_device *dev,
1552 void *data, struct drm_file *file_priv);
1553 extern int drm_mode_getplane(struct drm_device *dev,
1554 void *data, struct drm_file *file_priv);
1555 extern int drm_mode_setplane(struct drm_device *dev,
1556 void *data, struct drm_file *file_priv);
1557 extern int drm_mode_cursor_ioctl(struct drm_device *dev,
1558 void *data, struct drm_file *file_priv);
1559 extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
1560 void *data, struct drm_file *file_priv);
1561 extern int drm_mode_addfb(struct drm_device *dev,
1562 void *data, struct drm_file *file_priv);
1563 extern int drm_mode_addfb2(struct drm_device *dev,
1564 void *data, struct drm_file *file_priv);
1565 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
1566 extern int drm_mode_rmfb(struct drm_device *dev,
1567 void *data, struct drm_file *file_priv);
1568 extern int drm_mode_getfb(struct drm_device *dev,
1569 void *data, struct drm_file *file_priv);
1570 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1571 void *data, struct drm_file *file_priv);
1573 extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1574 void *data, struct drm_file *file_priv);
1575 extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1576 void *data, struct drm_file *file_priv);
1577 extern int drm_mode_createblob_ioctl(struct drm_device *dev,
1578 void *data, struct drm_file *file_priv);
1579 extern int drm_mode_destroyblob_ioctl(struct drm_device *dev,
1580 void *data, struct drm_file *file_priv);
1581 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1582 void *data, struct drm_file *file_priv);
1583 extern int drm_mode_getencoder(struct drm_device *dev,
1584 void *data, struct drm_file *file_priv);
1585 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1586 void *data, struct drm_file *file_priv);
1587 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1588 void *data, struct drm_file *file_priv);
1589 extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
1590 extern enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code);
1591 extern bool drm_detect_hdmi_monitor(struct edid *edid);
1592 extern bool drm_detect_monitor_audio(struct edid *edid);
1593 extern bool drm_rgb_quant_range_selectable(struct edid *edid);
1594 extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1595 void *data, struct drm_file *file_priv);
1596 extern int drm_add_modes_noedid(struct drm_connector *connector,
1597 int hdisplay, int vdisplay);
1598 extern void drm_set_preferred_mode(struct drm_connector *connector,
1599 int hpref, int vpref);
1601 extern int drm_edid_header_is_valid(const u8 *raw_edid);
1602 extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid,
1603 bool *edid_corrupt);
1604 extern bool drm_edid_is_valid(struct edid *edid);
1606 extern struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1608 extern struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1610 extern void drm_mode_put_tile_group(struct drm_device *dev,
1611 struct drm_tile_group *tg);
1612 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
1613 int hsize, int vsize, int fresh,
1616 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1617 void *data, struct drm_file *file_priv);
1618 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1619 void *data, struct drm_file *file_priv);
1620 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1621 void *data, struct drm_file *file_priv);
1622 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1623 struct drm_file *file_priv);
1624 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1625 struct drm_file *file_priv);
1626 extern int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
1627 struct drm_property *property,
1629 extern int drm_mode_atomic_ioctl(struct drm_device *dev,
1630 void *data, struct drm_file *file_priv);
1632 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1634 extern int drm_format_num_planes(uint32_t format);
1635 extern int drm_format_plane_bpp(uint32_t format, int plane);
1636 extern int drm_format_plane_cpp(uint32_t format, int plane);
1637 extern int drm_format_horz_chroma_subsampling(uint32_t format);
1638 extern int drm_format_vert_chroma_subsampling(uint32_t format);
1639 extern const char *drm_get_format_name(uint32_t format);
1640 extern struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
1641 unsigned int supported_rotations);
1642 extern unsigned int drm_rotation_simplify(unsigned int rotation,
1643 unsigned int supported_rotations);
1647 static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
1650 struct drm_mode_object *mo;
1651 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE);
1652 return mo ? obj_to_plane(mo) : NULL;
1655 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1658 struct drm_mode_object *mo;
1659 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1660 return mo ? obj_to_crtc(mo) : NULL;
1663 static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
1666 struct drm_mode_object *mo;
1667 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
1668 return mo ? obj_to_encoder(mo) : NULL;
1671 static inline struct drm_connector *drm_connector_find(struct drm_device *dev,
1674 struct drm_mode_object *mo;
1675 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR);
1676 return mo ? obj_to_connector(mo) : NULL;
1679 static inline struct drm_property *drm_property_find(struct drm_device *dev,
1682 struct drm_mode_object *mo;
1683 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY);
1684 return mo ? obj_to_property(mo) : NULL;
1687 /* Plane list iterator for legacy (overlay only) planes. */
1688 #define drm_for_each_legacy_plane(plane, dev) \
1689 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) \
1690 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1692 #define drm_for_each_plane(plane, dev) \
1693 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head)
1695 #define drm_for_each_crtc(crtc, dev) \
1696 list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)
1699 assert_drm_connector_list_read_locked(struct drm_mode_config *mode_config)
1702 * The connector hotadd/remove code currently grabs both locks when
1703 * updating lists. Hence readers need only hold either of them to be
1704 * safe and the check amounts to
1706 * WARN_ON(not_holding(A) && not_holding(B)).
1708 WARN_ON(!mutex_is_locked(&mode_config->mutex) &&
1709 !drm_modeset_is_locked(&mode_config->connection_mutex));
1712 #define drm_for_each_connector(connector, dev) \
1713 for (assert_drm_connector_list_read_locked(&(dev)->mode_config), \
1714 connector = list_first_entry(&(dev)->mode_config.connector_list, \
1715 struct drm_connector, head); \
1716 &connector->head != (&(dev)->mode_config.connector_list); \
1717 connector = list_next_entry(connector, head))
1719 #define drm_for_each_encoder(encoder, dev) \
1720 list_for_each_entry(encoder, &(dev)->mode_config.encoder_list, head)
1722 #define drm_for_each_fb(fb, dev) \
1723 for (WARN_ON(!mutex_is_locked(&(dev)->mode_config.fb_lock)), \
1724 fb = list_first_entry(&(dev)->mode_config.fb_list, \
1725 struct drm_framebuffer, head); \
1726 &fb->head != (&(dev)->mode_config.fb_list); \
1727 fb = list_next_entry(fb, head))
1729 #endif /* __DRM_CRTC_H__ */