2 * Copyright © 2006 Keith Packard
3 * Copyright © 2007-2008 Dave Airlie
4 * Copyright © 2007-2008 Intel Corporation
5 * Jesse Barnes <jesse.barnes@intel.com>
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
21 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
22 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23 * OTHER DEALINGS IN THE SOFTWARE.
25 #ifndef __DRM_CRTC_H__
26 #define __DRM_CRTC_H__
28 #include <linux/i2c.h>
29 #include <linux/spinlock.h>
30 #include <linux/types.h>
31 #include <linux/idr.h>
33 #include <linux/hdmi.h>
34 #include <linux/media-bus-format.h>
35 #include <uapi/drm/drm_mode.h>
36 #include <uapi/drm/drm_fourcc.h>
37 #include <drm/drm_modeset_lock.h>
41 struct drm_framebuffer;
42 struct drm_object_properties;
48 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
49 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
50 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
51 #define DRM_MODE_OBJECT_MODE 0xdededede
52 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
53 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
54 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
55 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
56 #define DRM_MODE_OBJECT_ANY 0
58 struct drm_mode_object {
61 struct drm_object_properties *properties;
64 #define DRM_OBJECT_MAX_PROPERTY 24
65 struct drm_object_properties {
66 int count, atomic_count;
67 /* NOTE: if we ever start dynamically destroying properties (ie.
68 * not at drm_mode_config_cleanup() time), then we'd have to do
69 * a better job of detaching property from mode objects to avoid
70 * dangling property pointers:
72 struct drm_property *properties[DRM_OBJECT_MAX_PROPERTY];
73 /* do not read/write values directly, but use drm_object_property_get_value()
74 * and drm_object_property_set_value():
76 uint64_t values[DRM_OBJECT_MAX_PROPERTY];
79 static inline int64_t U642I64(uint64_t val)
81 return (int64_t)*((int64_t *)&val);
83 static inline uint64_t I642U64(int64_t val)
85 return (uint64_t)*((uint64_t *)&val);
88 /* rotation property bits */
89 #define DRM_ROTATE_MASK 0x0f
90 #define DRM_ROTATE_0 0
91 #define DRM_ROTATE_90 1
92 #define DRM_ROTATE_180 2
93 #define DRM_ROTATE_270 3
94 #define DRM_REFLECT_MASK (~DRM_ROTATE_MASK)
95 #define DRM_REFLECT_X 4
96 #define DRM_REFLECT_Y 5
98 enum drm_connector_force {
99 DRM_FORCE_UNSPECIFIED,
101 DRM_FORCE_ON, /* force on analog part normally */
102 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
105 #include <drm/drm_modes.h>
107 enum drm_connector_status {
108 connector_status_connected = 1,
109 connector_status_disconnected = 2,
110 connector_status_unknown = 3,
113 enum subpixel_order {
115 SubPixelHorizontalRGB,
116 SubPixelHorizontalBGR,
122 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
123 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
124 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
126 * Describes a given display (e.g. CRT or flat panel) and its limitations.
128 struct drm_display_info {
129 char name[DRM_DISPLAY_INFO_LEN];
132 unsigned int width_mm;
133 unsigned int height_mm;
135 /* Clock limits FIXME: storage format */
136 unsigned int min_vfreq, max_vfreq;
137 unsigned int min_hfreq, max_hfreq;
138 unsigned int pixel_clock;
141 enum subpixel_order subpixel_order;
144 const u32 *bus_formats;
145 unsigned int num_bus_formats;
147 /* Mask of supported hdmi deep color modes */
148 u8 edid_hdmi_dc_modes;
153 /* data corresponds to displayid vend/prod/serial */
154 struct drm_tile_group {
155 struct kref refcount;
156 struct drm_device *dev;
161 struct drm_framebuffer_funcs {
162 /* note: use drm_framebuffer_remove() */
163 void (*destroy)(struct drm_framebuffer *framebuffer);
164 int (*create_handle)(struct drm_framebuffer *fb,
165 struct drm_file *file_priv,
166 unsigned int *handle);
168 * Optional callback for the dirty fb ioctl.
170 * Userspace can notify the driver via this callback
171 * that a area of the framebuffer has changed and should
172 * be flushed to the display hardware.
174 * See documentation in drm_mode.h for the struct
175 * drm_mode_fb_dirty_cmd for more information as all
176 * the semantics and arguments have a one to one mapping
179 int (*dirty)(struct drm_framebuffer *framebuffer,
180 struct drm_file *file_priv, unsigned flags,
181 unsigned color, struct drm_clip_rect *clips,
185 struct drm_framebuffer {
186 struct drm_device *dev;
188 * Note that the fb is refcounted for the benefit of driver internals,
189 * for example some hw, disabling a CRTC/plane is asynchronous, and
190 * scanout does not actually complete until the next vblank. So some
191 * cleanup (like releasing the reference(s) on the backing GEM bo(s))
192 * should be deferred. In cases like this, the driver would like to
193 * hold a ref to the fb even though it has already been removed from
194 * userspace perspective.
196 struct kref refcount;
198 * Place on the dev->mode_config.fb_list, access protected by
199 * dev->mode_config.fb_lock.
201 struct list_head head;
202 struct drm_mode_object base;
203 const struct drm_framebuffer_funcs *funcs;
204 unsigned int pitches[4];
205 unsigned int offsets[4];
206 uint64_t modifier[4];
209 /* depth can be 15 or 16 */
213 uint32_t pixel_format; /* fourcc format */
214 struct list_head filp_head;
217 struct drm_property_blob {
218 struct drm_mode_object base;
219 struct drm_device *dev;
220 struct kref refcount;
221 struct list_head head_global;
222 struct list_head head_file;
224 unsigned char data[];
227 struct drm_property_enum {
229 struct list_head head;
230 char name[DRM_PROP_NAME_LEN];
233 struct drm_property {
234 struct list_head head;
235 struct drm_mode_object base;
237 char name[DRM_PROP_NAME_LEN];
240 struct drm_device *dev;
242 struct list_head enum_list;
246 struct drm_connector;
248 struct drm_pending_vblank_event;
251 struct drm_atomic_state;
254 * struct drm_crtc_state - mutable CRTC state
255 * @crtc: backpointer to the CRTC
256 * @enable: whether the CRTC should be enabled, gates all other state
257 * @active: whether the CRTC is actively displaying (used for DPMS)
258 * @planes_changed: planes on this crtc are updated
259 * @mode_changed: crtc_state->mode or crtc_state->enable has been changed
260 * @active_changed: crtc_state->active has been toggled.
261 * @connectors_changed: connectors to this crtc have been updated
262 * @plane_mask: bitmask of (1 << drm_plane_index(plane)) of attached planes
263 * @last_vblank_count: for helpers and drivers to capture the vblank of the
264 * update to ensure framebuffer cleanup isn't done too early
265 * @adjusted_mode: for use by helpers and drivers to compute adjusted mode timings
266 * @mode: current mode timings
267 * @event: optional pointer to a DRM event to signal upon completion of the
269 * @state: backpointer to global drm_atomic_state
271 * Note that the distinction between @enable and @active is rather subtile:
272 * Flipping @active while @enable is set without changing anything else may
273 * never return in a failure from the ->atomic_check callback. Userspace assumes
274 * that a DPMS On will always succeed. In other words: @enable controls resource
275 * assignment, @active controls the actual hardware state.
277 struct drm_crtc_state {
278 struct drm_crtc *crtc;
283 /* computed state bits used by helpers and drivers */
284 bool planes_changed : 1;
285 bool mode_changed : 1;
286 bool active_changed : 1;
287 bool connectors_changed : 1;
289 /* attached planes bitmask:
290 * WARNING: transitional helpers do not maintain plane_mask so
291 * drivers not converted over to atomic helpers should not rely
292 * on plane_mask being accurate!
296 /* last_vblank_count: for vblank waits before cleanup */
297 u32 last_vblank_count;
299 /* adjusted_mode: for use by helpers and drivers */
300 struct drm_display_mode adjusted_mode;
302 struct drm_display_mode mode;
304 /* blob property to expose current mode to atomic userspace */
305 struct drm_property_blob *mode_blob;
307 struct drm_pending_vblank_event *event;
309 struct drm_atomic_state *state;
313 * struct drm_crtc_funcs - control CRTCs for a given device
314 * @save: save CRTC state
315 * @restore: restore CRTC state
316 * @reset: reset CRTC after state has been invalidated (e.g. resume)
317 * @cursor_set: setup the cursor
318 * @cursor_set2: setup the cursor with hotspot, superseeds @cursor_set if set
319 * @cursor_move: move the cursor
320 * @gamma_set: specify color ramp for CRTC
321 * @destroy: deinit and free object
322 * @set_property: called when a property is changed
323 * @set_config: apply a new CRTC configuration
324 * @page_flip: initiate a page flip
325 * @atomic_duplicate_state: duplicate the atomic state for this CRTC
326 * @atomic_destroy_state: destroy an atomic state for this CRTC
327 * @atomic_set_property: set a property on an atomic state for this CRTC
328 * (do not call directly, use drm_atomic_crtc_set_property())
329 * @atomic_get_property: get a property on an atomic state for this CRTC
330 * (do not call directly, use drm_atomic_crtc_get_property())
332 * The drm_crtc_funcs structure is the central CRTC management structure
333 * in the DRM. Each CRTC controls one or more connectors (note that the name
334 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
335 * connectors, not just CRTs).
337 * Each driver is responsible for filling out this structure at startup time,
338 * in addition to providing other modesetting features, like i2c and DDC
341 struct drm_crtc_funcs {
342 /* Save CRTC state */
343 void (*save)(struct drm_crtc *crtc); /* suspend? */
344 /* Restore CRTC state */
345 void (*restore)(struct drm_crtc *crtc); /* resume? */
346 /* Reset CRTC state */
347 void (*reset)(struct drm_crtc *crtc);
349 /* cursor controls */
350 int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
351 uint32_t handle, uint32_t width, uint32_t height);
352 int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
353 uint32_t handle, uint32_t width, uint32_t height,
354 int32_t hot_x, int32_t hot_y);
355 int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
357 /* Set gamma on the CRTC */
358 void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
359 uint32_t start, uint32_t size);
360 /* Object destroy routine */
361 void (*destroy)(struct drm_crtc *crtc);
363 int (*set_config)(struct drm_mode_set *set);
366 * Flip to the given framebuffer. This implements the page
367 * flip ioctl described in drm_mode.h, specifically, the
368 * implementation must return immediately and block all
369 * rendering to the current fb until the flip has completed.
370 * If userspace set the event flag in the ioctl, the event
371 * argument will point to an event to send back when the flip
372 * completes, otherwise it will be NULL.
374 int (*page_flip)(struct drm_crtc *crtc,
375 struct drm_framebuffer *fb,
376 struct drm_pending_vblank_event *event,
379 int (*set_property)(struct drm_crtc *crtc,
380 struct drm_property *property, uint64_t val);
382 /* atomic update handling */
383 struct drm_crtc_state *(*atomic_duplicate_state)(struct drm_crtc *crtc);
384 void (*atomic_destroy_state)(struct drm_crtc *crtc,
385 struct drm_crtc_state *state);
386 int (*atomic_set_property)(struct drm_crtc *crtc,
387 struct drm_crtc_state *state,
388 struct drm_property *property,
390 int (*atomic_get_property)(struct drm_crtc *crtc,
391 const struct drm_crtc_state *state,
392 struct drm_property *property,
397 * struct drm_crtc - central CRTC control structure
398 * @dev: parent DRM device
399 * @port: OF node used by drm_of_find_possible_crtcs()
400 * @head: list management
401 * @mutex: per-CRTC locking
402 * @base: base KMS object for ID tracking etc.
403 * @primary: primary plane for this CRTC
404 * @cursor: cursor plane for this CRTC
405 * @cursor_x: current x position of the cursor, used for universal cursor planes
406 * @cursor_y: current y position of the cursor, used for universal cursor planes
407 * @enabled: is this CRTC enabled?
408 * @mode: current mode timings
409 * @hwmode: mode timings as programmed to hw regs
410 * @x: x position on screen
411 * @y: y position on screen
412 * @funcs: CRTC control functions
413 * @gamma_size: size of gamma ramp
414 * @gamma_store: gamma ramp values
415 * @helper_private: mid-layer private data
416 * @properties: property tracking for this CRTC
417 * @state: current atomic state for this CRTC
418 * @acquire_ctx: per-CRTC implicit acquire context used by atomic drivers for
421 * Each CRTC may have one or more connectors associated with it. This structure
422 * allows the CRTC to be controlled.
425 struct drm_device *dev;
426 struct device_node *port;
427 struct list_head head;
432 * This provides a read lock for the overall crtc state (mode, dpms
433 * state, ...) and a write lock for everything which can be update
434 * without a full modeset (fb, cursor data, ...)
436 struct drm_modeset_lock mutex;
438 struct drm_mode_object base;
440 /* primary and cursor planes for CRTC */
441 struct drm_plane *primary;
442 struct drm_plane *cursor;
444 /* position of cursor plane on crtc */
450 /* Requested mode from modesetting. */
451 struct drm_display_mode mode;
453 /* Programmed mode in hw, after adjustments for encoders,
454 * crtc, panel scaling etc. Needed for timestamping etc.
456 struct drm_display_mode hwmode;
459 const struct drm_crtc_funcs *funcs;
461 /* CRTC gamma size for reporting to userspace */
463 uint16_t *gamma_store;
465 /* if you are using the helper */
466 const void *helper_private;
468 struct drm_object_properties properties;
470 struct drm_crtc_state *state;
473 * For legacy crtc ioctls so that atomic drivers can get at the locking
476 struct drm_modeset_acquire_ctx *acquire_ctx;
480 * struct drm_connector_state - mutable connector state
481 * @connector: backpointer to the connector
482 * @crtc: CRTC to connect connector to, NULL if disabled
483 * @best_encoder: can be used by helpers and drivers to select the encoder
484 * @state: backpointer to global drm_atomic_state
486 struct drm_connector_state {
487 struct drm_connector *connector;
489 struct drm_crtc *crtc; /* do not write directly, use drm_atomic_set_crtc_for_connector() */
491 struct drm_encoder *best_encoder;
493 struct drm_atomic_state *state;
497 * struct drm_connector_funcs - control connectors on a given device
498 * @dpms: set power state
499 * @save: save connector state
500 * @restore: restore connector state
501 * @reset: reset connector after state has been invalidated (e.g. resume)
502 * @detect: is this connector active?
503 * @fill_modes: fill mode list for this connector
504 * @set_property: property for this connector may need an update
505 * @destroy: make object go away
506 * @force: notify the driver that the connector is forced on
507 * @atomic_duplicate_state: duplicate the atomic state for this connector
508 * @atomic_destroy_state: destroy an atomic state for this connector
509 * @atomic_set_property: set a property on an atomic state for this connector
510 * (do not call directly, use drm_atomic_connector_set_property())
511 * @atomic_get_property: get a property on an atomic state for this connector
512 * (do not call directly, use drm_atomic_connector_get_property())
514 * Each CRTC may have one or more connectors attached to it. The functions
515 * below allow the core DRM code to control connectors, enumerate available modes,
518 struct drm_connector_funcs {
519 int (*dpms)(struct drm_connector *connector, int mode);
520 void (*save)(struct drm_connector *connector);
521 void (*restore)(struct drm_connector *connector);
522 void (*reset)(struct drm_connector *connector);
524 /* Check to see if anything is attached to the connector.
525 * @force is set to false whilst polling, true when checking the
526 * connector due to user request. @force can be used by the driver
527 * to avoid expensive, destructive operations during automated
530 enum drm_connector_status (*detect)(struct drm_connector *connector,
532 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
533 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
539 * This optional hook can be used to register additional userspace
540 * interfaces attached to the connector, light backlight control, i2c,
541 * DP aux or similar interfaces. It is called late in the driver load
542 * sequence from drm_connector_register() when registering all the
543 * core drm connector interfaces. Everything added from this callback
544 * should be unregistered in the early_unregister callback.
548 * 0 on success, or a negative error code on failure.
550 int (*late_register)(struct drm_connector *connector);
555 * This optional hook should be used to unregister the additional
556 * userspace interfaces attached to the connector from
557 * late_unregister(). It is called from drm_connector_unregister(),
558 * early in the driver unload sequence to disable userspace access
559 * before data structures are torndown.
561 void (*early_unregister)(struct drm_connector *connector);
563 void (*destroy)(struct drm_connector *connector);
564 void (*force)(struct drm_connector *connector);
566 /* atomic update handling */
567 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
568 void (*atomic_destroy_state)(struct drm_connector *connector,
569 struct drm_connector_state *state);
570 int (*atomic_set_property)(struct drm_connector *connector,
571 struct drm_connector_state *state,
572 struct drm_property *property,
574 int (*atomic_get_property)(struct drm_connector *connector,
575 const struct drm_connector_state *state,
576 struct drm_property *property,
581 * struct drm_encoder_funcs - encoder controls
582 * @reset: reset state (e.g. at init or resume time)
583 * @destroy: cleanup and free associated data
585 * Encoders sit between CRTCs and connectors.
587 struct drm_encoder_funcs {
588 void (*reset)(struct drm_encoder *encoder);
589 void (*destroy)(struct drm_encoder *encoder);
592 #define DRM_CONNECTOR_MAX_ENCODER 3
595 * struct drm_encoder - central DRM encoder structure
596 * @dev: parent DRM device
597 * @head: list management
598 * @base: base KMS object
599 * @name: encoder name
600 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
601 * @possible_crtcs: bitmask of potential CRTC bindings
602 * @possible_clones: bitmask of potential sibling encoders for cloning
603 * @crtc: currently bound CRTC
604 * @bridge: bridge associated to the encoder
605 * @funcs: control functions
606 * @helper_private: mid-layer private data
608 * CRTCs drive pixels to encoders, which convert them into signals
609 * appropriate for a given connector or set of connectors.
612 struct drm_device *dev;
613 struct list_head head;
615 struct drm_mode_object base;
618 uint32_t possible_crtcs;
619 uint32_t possible_clones;
621 struct drm_crtc *crtc;
622 struct drm_bridge *bridge;
623 const struct drm_encoder_funcs *funcs;
624 const void *helper_private;
627 /* should we poll this connector for connects and disconnects */
628 /* hot plug detectable */
629 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
630 /* poll for connections */
631 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
632 /* can cleanly poll for disconnections without flickering the screen */
633 /* DACs should rarely do this without a lot of testing */
634 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
636 #define MAX_ELD_BYTES 128
639 * struct drm_connector - central DRM connector control structure
640 * @dev: parent DRM device
641 * @port: OF node used by find connector by node.
642 * @kdev: kernel device for sysfs attributes
643 * @attr: sysfs attributes
644 * @head: list management
645 * @base: base KMS object
646 * @name: connector name
647 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
648 * @connector_type_id: index into connector type enum
649 * @interlace_allowed: can this connector handle interlaced modes?
650 * @doublescan_allowed: can this connector handle doublescan?
651 * @stereo_allowed: can this connector handle stereo modes?
652 * @modes: modes available on this connector (from fill_modes() + user)
653 * @status: one of the drm_connector_status enums (connected, not, or unknown)
654 * @probed_modes: list of modes derived directly from the display
655 * @display_info: information about attached display (e.g. from EDID)
656 * @funcs: connector control functions
657 * @edid_blob_ptr: DRM property containing EDID if present
658 * @properties: property tracking for this connector
659 * @path_blob_ptr: DRM blob property data for the DP MST path property
660 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
661 * @dpms: current dpms state
662 * @helper_private: mid-layer private data
663 * @cmdline_mode: mode line parsed from the kernel cmdline for this connector
664 * @force: a %DRM_FORCE_<foo> state for forced mode sets
665 * @override_edid: has the EDID been overwritten through debugfs for testing?
666 * @encoder_ids: valid encoders for this connector
667 * @encoder: encoder driving this connector, if any
668 * @eld: EDID-like data, if present
669 * @dvi_dual: dual link DVI, if found
670 * @max_tmds_clock: max clock rate, if found
671 * @latency_present: AV delay info from ELD, if found
672 * @video_latency: video latency info from ELD, if found
673 * @audio_latency: audio latency info from ELD, if found
674 * @null_edid_counter: track sinks that give us all zeros for the EDID
675 * @bad_edid_counter: track sinks that give us an EDID with invalid checksum
676 * @edid_corrupt: indicates whether the last read EDID was corrupt
677 * @debugfs_entry: debugfs directory for this connector
678 * @state: current atomic state for this connector
679 * @has_tile: is this connector connected to a tiled monitor
680 * @tile_group: tile group for the connected monitor
681 * @tile_is_single_monitor: whether the tile is one monitor housing
682 * @num_h_tile: number of horizontal tiles in the tile group
683 * @num_v_tile: number of vertical tiles in the tile group
684 * @tile_h_loc: horizontal location of this tile
685 * @tile_v_loc: vertical location of this tile
686 * @tile_h_size: horizontal size of this tile.
687 * @tile_v_size: vertical size of this tile.
689 * Each connector may be connected to one or more CRTCs, or may be clonable by
690 * another connector if they can share a CRTC. Each connector also has a specific
691 * position in the broader display (referred to as a 'screen' though it could
692 * span multiple monitors).
694 struct drm_connector {
695 struct drm_device *dev;
696 struct device_node *port;
698 struct device_attribute *attr;
699 struct list_head head;
701 struct drm_mode_object base;
705 int connector_type_id;
706 bool interlace_allowed;
707 bool doublescan_allowed;
709 struct list_head modes; /* list of modes on this connector */
711 enum drm_connector_status status;
713 /* these are modes added by probing with DDC or the BIOS */
714 struct list_head probed_modes;
716 struct drm_display_info display_info;
717 const struct drm_connector_funcs *funcs;
719 struct drm_property_blob *edid_blob_ptr;
720 struct drm_object_properties properties;
722 struct drm_property_blob *path_blob_ptr;
724 struct drm_property_blob *tile_blob_ptr;
726 uint8_t polled; /* DRM_CONNECTOR_POLL_* */
728 /* requested DPMS state */
731 const void *helper_private;
733 /* forced on connector */
734 struct drm_cmdline_mode cmdline_mode;
735 enum drm_connector_force force;
737 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
738 struct drm_encoder *encoder; /* currently active encoder */
742 uint8_t eld[MAX_ELD_BYTES];
744 int max_tmds_clock; /* in MHz */
745 bool latency_present[2];
746 int video_latency[2]; /* [0]: progressive, [1]: interlaced */
747 int audio_latency[2];
748 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
749 unsigned bad_edid_counter;
751 /* Flag for raw EDID header corruption - used in Displayport
752 * compliance testing - * Displayport Link CTS Core 1.2 rev1.1 4.2.2.6
756 struct dentry *debugfs_entry;
758 struct drm_connector_state *state;
762 struct drm_tile_group *tile_group;
763 bool tile_is_single_monitor;
765 uint8_t num_h_tile, num_v_tile;
766 uint8_t tile_h_loc, tile_v_loc;
767 uint16_t tile_h_size, tile_v_size;
771 * struct drm_plane_state - mutable plane state
772 * @plane: backpointer to the plane
773 * @crtc: currently bound CRTC, NULL if disabled
774 * @fb: currently bound framebuffer
775 * @fence: optional fence to wait for before scanning out @fb
776 * @crtc_x: left position of visible portion of plane on crtc
777 * @crtc_y: upper position of visible portion of plane on crtc
778 * @crtc_w: width of visible portion of plane on crtc
779 * @crtc_h: height of visible portion of plane on crtc
780 * @src_x: left position of visible portion of plane within
782 * @src_y: upper position of visible portion of plane within
784 * @src_w: width of visible portion of plane (in 16.16)
785 * @src_h: height of visible portion of plane (in 16.16)
786 * @state: backpointer to global drm_atomic_state
788 struct drm_plane_state {
789 struct drm_plane *plane;
791 struct drm_crtc *crtc; /* do not write directly, use drm_atomic_set_crtc_for_plane() */
792 struct drm_framebuffer *fb; /* do not write directly, use drm_atomic_set_fb_for_plane() */
795 /* Signed dest location allows it to be partially off screen */
796 int32_t crtc_x, crtc_y;
797 uint32_t crtc_w, crtc_h;
799 /* Source values are 16.16 fixed point */
800 uint32_t src_x, src_y;
801 uint32_t src_h, src_w;
804 unsigned int rotation;
806 struct drm_atomic_state *state;
811 * struct drm_plane_funcs - driver plane control functions
812 * @update_plane: update the plane configuration
813 * @disable_plane: shut down the plane
814 * @destroy: clean up plane resources
815 * @reset: reset plane after state has been invalidated (e.g. resume)
816 * @set_property: called when a property is changed
817 * @atomic_duplicate_state: duplicate the atomic state for this plane
818 * @atomic_destroy_state: destroy an atomic state for this plane
819 * @atomic_set_property: set a property on an atomic state for this plane
820 * (do not call directly, use drm_atomic_plane_set_property())
821 * @atomic_get_property: get a property on an atomic state for this plane
822 * (do not call directly, use drm_atomic_plane_get_property())
824 struct drm_plane_funcs {
825 int (*update_plane)(struct drm_plane *plane,
826 struct drm_crtc *crtc, struct drm_framebuffer *fb,
827 int crtc_x, int crtc_y,
828 unsigned int crtc_w, unsigned int crtc_h,
829 uint32_t src_x, uint32_t src_y,
830 uint32_t src_w, uint32_t src_h);
831 int (*disable_plane)(struct drm_plane *plane);
832 void (*destroy)(struct drm_plane *plane);
833 void (*reset)(struct drm_plane *plane);
835 int (*set_property)(struct drm_plane *plane,
836 struct drm_property *property, uint64_t val);
838 /* atomic update handling */
839 struct drm_plane_state *(*atomic_duplicate_state)(struct drm_plane *plane);
840 void (*atomic_destroy_state)(struct drm_plane *plane,
841 struct drm_plane_state *state);
842 int (*atomic_set_property)(struct drm_plane *plane,
843 struct drm_plane_state *state,
844 struct drm_property *property,
846 int (*atomic_get_property)(struct drm_plane *plane,
847 const struct drm_plane_state *state,
848 struct drm_property *property,
852 enum drm_plane_type {
853 DRM_PLANE_TYPE_OVERLAY,
854 DRM_PLANE_TYPE_PRIMARY,
855 DRM_PLANE_TYPE_CURSOR,
859 * struct drm_plane - central DRM plane control structure
860 * @dev: DRM device this plane belongs to
861 * @parent: this plane share some resources with parent plane.
862 * @head: for list management
863 * @base: base mode object
864 * @possible_crtcs: pipes this plane can be bound to
865 * @format_types: array of formats supported by this plane
866 * @format_count: number of formats supported
867 * @format_default: driver hasn't supplied supported formats for the plane
868 * @crtc: currently bound CRTC
869 * @fb: currently bound fb
870 * @old_fb: Temporary tracking of the old fb while a modeset is ongoing. Used by
871 * drm_mode_set_config_internal() to implement correct refcounting.
872 * @funcs: helper functions
873 * @properties: property tracking for this plane
874 * @type: type of plane (overlay, primary, cursor)
875 * @state: current atomic state for this plane
878 struct drm_device *dev;
879 struct drm_plane *parent;
880 struct list_head head;
882 struct drm_modeset_lock mutex;
884 struct drm_mode_object base;
886 uint32_t possible_crtcs;
887 uint32_t *format_types;
888 unsigned int format_count;
891 struct drm_crtc *crtc;
892 struct drm_framebuffer *fb;
894 struct drm_framebuffer *old_fb;
896 const struct drm_plane_funcs *funcs;
898 struct drm_object_properties properties;
900 enum drm_plane_type type;
902 const void *helper_private;
904 struct drm_plane_state *state;
908 * struct drm_bridge_funcs - drm_bridge control functions
909 * @attach: Called during drm_bridge_attach
910 * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
911 * @disable: Called right before encoder prepare, disables the bridge
912 * @post_disable: Called right after encoder prepare, for lockstepped disable
913 * @mode_set: Set this mode to the bridge
914 * @pre_enable: Called right before encoder commit, for lockstepped commit
915 * @enable: Called right after encoder commit, enables the bridge
917 struct drm_bridge_funcs {
918 int (*attach)(struct drm_bridge *bridge);
919 bool (*mode_fixup)(struct drm_bridge *bridge,
920 const struct drm_display_mode *mode,
921 struct drm_display_mode *adjusted_mode);
922 void (*disable)(struct drm_bridge *bridge);
923 void (*post_disable)(struct drm_bridge *bridge);
924 void (*mode_set)(struct drm_bridge *bridge,
925 struct drm_display_mode *mode,
926 struct drm_display_mode *adjusted_mode);
927 void (*pre_enable)(struct drm_bridge *bridge);
928 void (*enable)(struct drm_bridge *bridge);
932 * struct drm_bridge - central DRM bridge control structure
933 * @dev: DRM device this bridge belongs to
934 * @encoder: encoder to which this bridge is connected
935 * @next: the next bridge in the encoder chain
936 * @of_node: device node pointer to the bridge
937 * @list: to keep track of all added bridges
938 * @funcs: control functions
939 * @driver_private: pointer to the bridge driver's internal context
942 struct drm_device *dev;
943 struct drm_encoder *encoder;
944 struct drm_bridge *next;
946 struct device_node *of_node;
948 struct list_head list;
950 const struct drm_bridge_funcs *funcs;
951 void *driver_private;
955 * struct drm_atomic_state - the global state object for atomic updates
956 * @dev: parent DRM device
957 * @allow_modeset: allow full modeset
958 * @legacy_cursor_update: hint to enforce legacy cursor ioctl semantics
959 * @planes: pointer to array of plane pointers
960 * @plane_states: pointer to array of plane states pointers
961 * @crtcs: pointer to array of CRTC pointers
962 * @crtc_states: pointer to array of CRTC states pointers
963 * @num_connector: size of the @connectors and @connector_states arrays
964 * @connectors: pointer to array of connector pointers
965 * @connector_states: pointer to array of connector states pointers
966 * @acquire_ctx: acquire context for this atomic modeset state update
968 struct drm_atomic_state {
969 struct drm_device *dev;
970 bool allow_modeset : 1;
971 bool legacy_cursor_update : 1;
972 struct drm_plane **planes;
973 struct drm_plane_state **plane_states;
974 struct drm_crtc **crtcs;
975 struct drm_crtc_state **crtc_states;
977 struct drm_connector **connectors;
978 struct drm_connector_state **connector_states;
980 struct drm_modeset_acquire_ctx *acquire_ctx;
985 * struct drm_mode_set - new values for a CRTC config change
986 * @fb: framebuffer to use for new config
987 * @crtc: CRTC whose configuration we're about to change
988 * @mode: mode timings to use
989 * @x: position of this CRTC relative to @fb
990 * @y: position of this CRTC relative to @fb
991 * @connectors: array of connectors to drive with this CRTC if possible
992 * @num_connectors: size of @connectors array
994 * Represents a single crtc the connectors that it drives with what mode
995 * and from which framebuffer it scans out from.
997 * This is used to set modes.
999 struct drm_mode_set {
1000 struct drm_framebuffer *fb;
1001 struct drm_crtc *crtc;
1002 struct drm_display_mode *mode;
1007 struct drm_connector **connectors;
1008 size_t num_connectors;
1012 * struct drm_mode_config_funcs - basic driver provided mode setting functions
1013 * @fb_create: create a new framebuffer object
1014 * @output_poll_changed: function to handle output configuration changes
1015 * @atomic_check: check whether a given atomic state update is possible
1016 * @atomic_commit: commit an atomic state update previously verified with
1018 * @atomic_state_alloc: allocate a new atomic state
1019 * @atomic_state_clear: clear the atomic state
1020 * @atomic_state_free: free the atomic state
1022 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
1025 struct drm_mode_config_funcs {
1026 struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
1027 struct drm_file *file_priv,
1028 struct drm_mode_fb_cmd2 *mode_cmd);
1029 void (*output_poll_changed)(struct drm_device *dev);
1031 int (*atomic_check)(struct drm_device *dev,
1032 struct drm_atomic_state *a);
1033 int (*atomic_commit)(struct drm_device *dev,
1034 struct drm_atomic_state *a,
1036 struct drm_atomic_state *(*atomic_state_alloc)(struct drm_device *dev);
1037 void (*atomic_state_clear)(struct drm_atomic_state *state);
1038 void (*atomic_state_free)(struct drm_atomic_state *state);
1042 * struct drm_mode_config - Mode configuration control structure
1043 * @mutex: mutex protecting KMS related lists and structures
1044 * @connection_mutex: ww mutex protecting connector state and routing
1045 * @acquire_ctx: global implicit acquire context used by atomic drivers for
1047 * @idr_mutex: mutex for KMS ID allocation and management
1048 * @crtc_idr: main KMS ID tracking object
1049 * @fb_lock: mutex to protect fb state and lists
1050 * @num_fb: number of fbs available
1051 * @fb_list: list of framebuffers available
1052 * @num_connector: number of connectors on this device
1053 * @connector_list: list of connector objects
1054 * @num_encoder: number of encoders on this device
1055 * @encoder_list: list of encoder objects
1056 * @num_overlay_plane: number of overlay planes on this device
1057 * @num_total_plane: number of universal (i.e. with primary/curso) planes on this device
1058 * @plane_list: list of plane objects
1059 * @num_crtc: number of CRTCs on this device
1060 * @crtc_list: list of CRTC objects
1061 * @property_list: list of property objects
1062 * @min_width: minimum pixel width on this device
1063 * @min_height: minimum pixel height on this device
1064 * @max_width: maximum pixel width on this device
1065 * @max_height: maximum pixel height on this device
1066 * @funcs: core driver provided mode setting functions
1067 * @fb_base: base address of the framebuffer
1068 * @poll_enabled: track polling support for this device
1069 * @poll_running: track polling status for this device
1070 * @output_poll_work: delayed work for polling in process context
1071 * @property_blob_list: list of all the blob property objects
1072 * @blob_lock: mutex for blob property allocation and management
1073 * @*_property: core property tracking
1074 * @preferred_depth: preferred RBG pixel depth, used by fb helpers
1075 * @prefer_shadow: hint to userspace to prefer shadow-fb rendering
1076 * @async_page_flip: does this device support async flips on the primary plane?
1077 * @cursor_width: hint to userspace for max cursor width
1078 * @cursor_height: hint to userspace for max cursor height
1080 * Core mode resource tracking structure. All CRTC, encoders, and connectors
1081 * enumerated by the driver are added here, as are global properties. Some
1082 * global restrictions are also here, e.g. dimension restrictions.
1084 struct drm_mode_config {
1085 struct mutex mutex; /* protects configuration (mode lists etc.) */
1086 struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */
1087 struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */
1088 struct mutex idr_mutex; /* for IDR management */
1089 struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
1090 struct idr tile_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
1091 /* this is limited to one for now */
1093 struct mutex fb_lock; /* proctects global and per-file fb lists */
1095 struct list_head fb_list;
1098 struct list_head connector_list;
1100 struct list_head encoder_list;
1103 * Track # of overlay planes separately from # of total planes. By
1104 * default we only advertise overlay planes to userspace; if userspace
1105 * sets the "universal plane" capability bit, we'll go ahead and
1106 * expose all planes.
1108 int num_overlay_plane;
1109 int num_total_plane;
1110 int num_share_plane;
1111 int num_share_overlay_plane;
1112 struct list_head plane_list;
1115 struct list_head crtc_list;
1117 struct list_head property_list;
1119 int min_width, min_height;
1120 int max_width, max_height;
1121 const struct drm_mode_config_funcs *funcs;
1122 resource_size_t fb_base;
1124 /* output poll support */
1128 struct delayed_work output_poll_work;
1130 struct mutex blob_lock;
1132 /* pointers to share properties */
1133 struct drm_property *prop_share_id;
1134 struct drm_property *prop_share_flags;
1136 /* pointers to standard properties */
1137 struct list_head property_blob_list;
1138 struct drm_property *edid_property;
1139 struct drm_property *dpms_property;
1140 struct drm_property *path_property;
1141 struct drm_property *tile_property;
1142 struct drm_property *plane_type_property;
1143 struct drm_property *rotation_property;
1144 struct drm_property *prop_src_x;
1145 struct drm_property *prop_src_y;
1146 struct drm_property *prop_src_w;
1147 struct drm_property *prop_src_h;
1148 struct drm_property *prop_crtc_x;
1149 struct drm_property *prop_crtc_y;
1150 struct drm_property *prop_crtc_w;
1151 struct drm_property *prop_crtc_h;
1152 struct drm_property *prop_fb_id;
1153 struct drm_property *prop_crtc_id;
1154 struct drm_property *prop_active;
1155 struct drm_property *prop_mode_id;
1157 /* DVI-I properties */
1158 struct drm_property *dvi_i_subconnector_property;
1159 struct drm_property *dvi_i_select_subconnector_property;
1162 struct drm_property *tv_subconnector_property;
1163 struct drm_property *tv_select_subconnector_property;
1164 struct drm_property *tv_mode_property;
1165 struct drm_property *tv_left_margin_property;
1166 struct drm_property *tv_right_margin_property;
1167 struct drm_property *tv_top_margin_property;
1168 struct drm_property *tv_bottom_margin_property;
1169 struct drm_property *tv_brightness_property;
1170 struct drm_property *tv_contrast_property;
1171 struct drm_property *tv_flicker_reduction_property;
1172 struct drm_property *tv_overscan_property;
1173 struct drm_property *tv_saturation_property;
1174 struct drm_property *tv_hue_property;
1176 /* Optional properties */
1177 struct drm_property *scaling_mode_property;
1178 struct drm_property *aspect_ratio_property;
1179 struct drm_property *dirty_info_property;
1181 /* properties for virtual machine layout */
1182 struct drm_property *suggested_x_property;
1183 struct drm_property *suggested_y_property;
1185 /* dumb ioctl parameters */
1186 uint32_t preferred_depth, prefer_shadow;
1188 /* whether async page flip is supported or not */
1189 bool async_page_flip;
1191 /* whether the driver supports fb modifiers */
1192 bool allow_fb_modifiers;
1195 uint32_t cursor_width, cursor_height;
1199 * drm_for_each_plane_mask - iterate over planes specified by bitmask
1200 * @plane: the loop cursor
1201 * @dev: the DRM device
1202 * @plane_mask: bitmask of plane indices
1204 * Iterate over all planes specified by bitmask.
1206 #define drm_for_each_plane_mask(plane, dev, plane_mask) \
1207 list_for_each_entry((plane), &(dev)->mode_config.plane_list, head) \
1208 if ((plane_mask) & (1 << drm_plane_index(plane)))
1211 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
1212 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
1213 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
1214 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
1215 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
1216 #define obj_to_property(x) container_of(x, struct drm_property, base)
1217 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
1218 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
1220 struct drm_prop_enum_list {
1225 extern __printf(6, 7)
1226 int drm_crtc_init_with_planes(struct drm_device *dev,
1227 struct drm_crtc *crtc,
1228 struct drm_plane *primary,
1229 struct drm_plane *cursor,
1230 const struct drm_crtc_funcs *funcs,
1231 const char *name, ...);
1232 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
1233 extern unsigned int drm_crtc_index(struct drm_crtc *crtc);
1236 * drm_crtc_mask - find the mask of a registered CRTC
1237 * @crtc: CRTC to find mask for
1239 * Given a registered CRTC, return the mask bit of that CRTC for an
1240 * encoder's possible_crtcs field.
1242 static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
1244 return 1 << drm_crtc_index(crtc);
1247 extern void drm_connector_ida_init(void);
1248 extern void drm_connector_ida_destroy(void);
1249 extern int drm_connector_init(struct drm_device *dev,
1250 struct drm_connector *connector,
1251 const struct drm_connector_funcs *funcs,
1252 int connector_type);
1253 int drm_connector_register(struct drm_connector *connector);
1254 void drm_connector_unregister(struct drm_connector *connector);
1256 extern void drm_connector_cleanup(struct drm_connector *connector);
1257 extern unsigned int drm_connector_index(struct drm_connector *connector);
1258 /* helper to unregister all connectors from sysfs for device */
1259 extern void drm_connector_unregister_all(struct drm_device *dev);
1261 extern int drm_bridge_add(struct drm_bridge *bridge);
1262 extern void drm_bridge_remove(struct drm_bridge *bridge);
1263 extern struct drm_bridge *of_drm_find_bridge(struct device_node *np);
1264 extern int drm_bridge_attach(struct drm_device *dev, struct drm_bridge *bridge);
1266 bool drm_bridge_mode_fixup(struct drm_bridge *bridge,
1267 const struct drm_display_mode *mode,
1268 struct drm_display_mode *adjusted_mode);
1269 void drm_bridge_disable(struct drm_bridge *bridge);
1270 void drm_bridge_post_disable(struct drm_bridge *bridge);
1271 void drm_bridge_mode_set(struct drm_bridge *bridge,
1272 struct drm_display_mode *mode,
1273 struct drm_display_mode *adjusted_mode);
1274 void drm_bridge_pre_enable(struct drm_bridge *bridge);
1275 void drm_bridge_enable(struct drm_bridge *bridge);
1277 extern __printf(5, 6)
1278 int drm_encoder_init(struct drm_device *dev,
1279 struct drm_encoder *encoder,
1280 const struct drm_encoder_funcs *funcs,
1281 int encoder_type, const char *name, ...);
1284 * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
1285 * @encoder: encoder to test
1286 * @crtc: crtc to test
1288 * Return false if @encoder can't be driven by @crtc, true otherwise.
1290 static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
1291 struct drm_crtc *crtc)
1293 return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
1296 extern __printf(8, 9)
1297 int drm_universal_plane_init(struct drm_device *dev,
1298 struct drm_plane *plane,
1299 unsigned long possible_crtcs,
1300 const struct drm_plane_funcs *funcs,
1301 const uint32_t *formats,
1302 unsigned int format_count,
1303 enum drm_plane_type type,
1304 const char *name, ...);
1305 extern int drm_plane_init(struct drm_device *dev,
1306 struct drm_plane *plane,
1307 unsigned long possible_crtcs,
1308 const struct drm_plane_funcs *funcs,
1309 const uint32_t *formats, unsigned int format_count,
1311 extern int drm_share_plane_init(struct drm_device *dev, struct drm_plane *plane,
1312 struct drm_plane *parent,
1313 unsigned long possible_crtcs,
1314 const struct drm_plane_funcs *funcs,
1315 const uint32_t *formats,
1316 unsigned int format_count,
1317 enum drm_plane_type type);
1318 extern void drm_plane_cleanup(struct drm_plane *plane);
1319 extern unsigned int drm_plane_index(struct drm_plane *plane);
1320 extern struct drm_plane * drm_plane_from_index(struct drm_device *dev, int idx);
1321 extern void drm_plane_force_disable(struct drm_plane *plane);
1322 extern int drm_plane_check_pixel_format(const struct drm_plane *plane,
1324 extern void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
1325 int *hdisplay, int *vdisplay);
1326 extern int drm_crtc_check_viewport(const struct drm_crtc *crtc,
1328 const struct drm_display_mode *mode,
1329 const struct drm_framebuffer *fb);
1331 extern void drm_encoder_cleanup(struct drm_encoder *encoder);
1333 extern const char *drm_get_connector_status_name(enum drm_connector_status status);
1334 extern const char *drm_get_subpixel_order_name(enum subpixel_order order);
1335 extern const char *drm_get_dpms_name(int val);
1336 extern const char *drm_get_dvi_i_subconnector_name(int val);
1337 extern const char *drm_get_dvi_i_select_name(int val);
1338 extern const char *drm_get_tv_subconnector_name(int val);
1339 extern const char *drm_get_tv_select_name(int val);
1340 extern void drm_fb_release(struct drm_file *file_priv);
1341 extern void drm_property_destroy_user_blobs(struct drm_device *dev,
1342 struct drm_file *file_priv);
1343 extern bool drm_probe_ddc(struct i2c_adapter *adapter);
1344 extern struct edid *drm_get_edid(struct drm_connector *connector,
1345 struct i2c_adapter *adapter);
1346 extern struct edid *drm_edid_duplicate(const struct edid *edid);
1347 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
1348 extern void drm_mode_config_init(struct drm_device *dev);
1349 extern void drm_mode_config_reset(struct drm_device *dev);
1350 extern void drm_mode_config_cleanup(struct drm_device *dev);
1352 extern int drm_mode_connector_set_path_property(struct drm_connector *connector,
1354 int drm_mode_connector_set_tile_property(struct drm_connector *connector);
1355 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
1356 const struct edid *edid);
1358 extern int drm_display_info_set_bus_formats(struct drm_display_info *info,
1360 unsigned int num_formats);
1362 static inline bool drm_property_type_is(struct drm_property *property,
1365 /* instanceof for props.. handles extended type vs original types: */
1366 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
1367 return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;
1368 return property->flags & type;
1371 static inline bool drm_property_type_valid(struct drm_property *property)
1373 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
1374 return !(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
1375 return !!(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
1378 extern int drm_object_property_set_value(struct drm_mode_object *obj,
1379 struct drm_property *property,
1381 extern int drm_object_property_get_value(struct drm_mode_object *obj,
1382 struct drm_property *property,
1384 extern int drm_framebuffer_init(struct drm_device *dev,
1385 struct drm_framebuffer *fb,
1386 const struct drm_framebuffer_funcs *funcs);
1387 extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
1389 extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
1390 extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
1391 extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
1392 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
1393 extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
1395 extern void drm_object_attach_property(struct drm_mode_object *obj,
1396 struct drm_property *property,
1398 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
1399 const char *name, int num_values);
1400 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
1402 const struct drm_prop_enum_list *props,
1404 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
1405 int flags, const char *name,
1406 const struct drm_prop_enum_list *props,
1408 uint64_t supported_bits);
1409 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
1411 uint64_t min, uint64_t max);
1412 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
1413 int flags, const char *name,
1414 int64_t min, int64_t max);
1415 struct drm_property *drm_property_create_object(struct drm_device *dev,
1416 int flags, const char *name, uint32_t type);
1417 struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags,
1419 struct drm_property_blob *drm_property_create_blob(struct drm_device *dev,
1422 struct drm_property_blob *drm_property_lookup_blob(struct drm_device *dev,
1424 struct drm_property_blob *drm_property_reference_blob(struct drm_property_blob *blob);
1425 void drm_property_unreference_blob(struct drm_property_blob *blob);
1426 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
1427 extern int drm_property_add_enum(struct drm_property *property, int index,
1428 uint64_t value, const char *name);
1429 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1430 extern int drm_mode_create_tv_properties(struct drm_device *dev,
1431 unsigned int num_modes,
1432 const char * const modes[]);
1433 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1434 extern int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1435 extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
1436 extern int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
1437 extern bool drm_property_change_valid_get(struct drm_property *property,
1438 uint64_t value, struct drm_mode_object **ref);
1439 extern void drm_property_change_valid_put(struct drm_property *property,
1440 struct drm_mode_object *ref);
1442 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
1443 struct drm_encoder *encoder);
1444 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
1446 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
1447 uint32_t id, uint32_t type);
1450 extern int drm_mode_getresources(struct drm_device *dev,
1451 void *data, struct drm_file *file_priv);
1452 extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
1453 struct drm_file *file_priv);
1454 extern int drm_mode_getcrtc(struct drm_device *dev,
1455 void *data, struct drm_file *file_priv);
1456 extern int drm_mode_getconnector(struct drm_device *dev,
1457 void *data, struct drm_file *file_priv);
1458 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
1459 extern int drm_mode_setcrtc(struct drm_device *dev,
1460 void *data, struct drm_file *file_priv);
1461 extern int drm_mode_getplane(struct drm_device *dev,
1462 void *data, struct drm_file *file_priv);
1463 extern int drm_mode_setplane(struct drm_device *dev,
1464 void *data, struct drm_file *file_priv);
1465 extern int drm_mode_cursor_ioctl(struct drm_device *dev,
1466 void *data, struct drm_file *file_priv);
1467 extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
1468 void *data, struct drm_file *file_priv);
1469 extern int drm_mode_addfb(struct drm_device *dev,
1470 void *data, struct drm_file *file_priv);
1471 extern int drm_mode_addfb2(struct drm_device *dev,
1472 void *data, struct drm_file *file_priv);
1473 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
1474 extern int drm_mode_rmfb(struct drm_device *dev,
1475 void *data, struct drm_file *file_priv);
1476 extern int drm_mode_getfb(struct drm_device *dev,
1477 void *data, struct drm_file *file_priv);
1478 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1479 void *data, struct drm_file *file_priv);
1481 extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1482 void *data, struct drm_file *file_priv);
1483 extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1484 void *data, struct drm_file *file_priv);
1485 extern int drm_mode_createblob_ioctl(struct drm_device *dev,
1486 void *data, struct drm_file *file_priv);
1487 extern int drm_mode_destroyblob_ioctl(struct drm_device *dev,
1488 void *data, struct drm_file *file_priv);
1489 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1490 void *data, struct drm_file *file_priv);
1491 extern int drm_mode_getencoder(struct drm_device *dev,
1492 void *data, struct drm_file *file_priv);
1493 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1494 void *data, struct drm_file *file_priv);
1495 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1496 void *data, struct drm_file *file_priv);
1497 extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
1498 extern enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code);
1499 extern bool drm_detect_hdmi_monitor(struct edid *edid);
1500 extern bool drm_detect_monitor_audio(struct edid *edid);
1501 extern bool drm_rgb_quant_range_selectable(struct edid *edid);
1502 extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1503 void *data, struct drm_file *file_priv);
1504 extern int drm_add_modes_noedid(struct drm_connector *connector,
1505 int hdisplay, int vdisplay);
1506 extern void drm_set_preferred_mode(struct drm_connector *connector,
1507 int hpref, int vpref);
1509 extern int drm_edid_header_is_valid(const u8 *raw_edid);
1510 extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid,
1511 bool *edid_corrupt);
1512 extern bool drm_edid_is_valid(struct edid *edid);
1514 extern struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1516 extern struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1518 extern void drm_mode_put_tile_group(struct drm_device *dev,
1519 struct drm_tile_group *tg);
1520 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
1521 int hsize, int vsize, int fresh,
1524 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1525 void *data, struct drm_file *file_priv);
1526 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1527 void *data, struct drm_file *file_priv);
1528 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1529 void *data, struct drm_file *file_priv);
1530 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1531 struct drm_file *file_priv);
1532 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1533 struct drm_file *file_priv);
1534 extern int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
1535 struct drm_property *property,
1537 extern int drm_mode_atomic_ioctl(struct drm_device *dev,
1538 void *data, struct drm_file *file_priv);
1540 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1542 extern int drm_format_num_planes(uint32_t format);
1543 extern int drm_format_plane_bpp(uint32_t format, int plane);
1544 extern int drm_format_plane_cpp(uint32_t format, int plane);
1545 extern int drm_format_horz_chroma_subsampling(uint32_t format);
1546 extern int drm_format_vert_chroma_subsampling(uint32_t format);
1547 extern const char *drm_get_format_name(uint32_t format);
1548 extern struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
1549 unsigned int supported_rotations);
1550 extern unsigned int drm_rotation_simplify(unsigned int rotation,
1551 unsigned int supported_rotations);
1555 static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
1558 struct drm_mode_object *mo;
1559 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE);
1560 return mo ? obj_to_plane(mo) : NULL;
1563 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1566 struct drm_mode_object *mo;
1567 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1568 return mo ? obj_to_crtc(mo) : NULL;
1571 static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
1574 struct drm_mode_object *mo;
1575 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
1576 return mo ? obj_to_encoder(mo) : NULL;
1579 static inline struct drm_connector *drm_connector_find(struct drm_device *dev,
1582 struct drm_mode_object *mo;
1583 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR);
1584 return mo ? obj_to_connector(mo) : NULL;
1587 static inline struct drm_property *drm_property_find(struct drm_device *dev,
1590 struct drm_mode_object *mo;
1591 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY);
1592 return mo ? obj_to_property(mo) : NULL;
1595 /* Plane list iterator for legacy (overlay only) planes. */
1596 #define drm_for_each_legacy_plane(plane, dev) \
1597 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) \
1598 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1600 #define drm_for_each_plane(plane, dev) \
1601 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head)
1603 #define drm_for_each_crtc(crtc, dev) \
1604 list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)
1607 assert_drm_connector_list_read_locked(struct drm_mode_config *mode_config)
1610 * The connector hotadd/remove code currently grabs both locks when
1611 * updating lists. Hence readers need only hold either of them to be
1612 * safe and the check amounts to
1614 * WARN_ON(not_holding(A) && not_holding(B)).
1616 WARN_ON(!mutex_is_locked(&mode_config->mutex) &&
1617 !drm_modeset_is_locked(&mode_config->connection_mutex));
1620 #define drm_for_each_connector(connector, dev) \
1621 for (assert_drm_connector_list_read_locked(&(dev)->mode_config), \
1622 connector = list_first_entry(&(dev)->mode_config.connector_list, \
1623 struct drm_connector, head); \
1624 &connector->head != (&(dev)->mode_config.connector_list); \
1625 connector = list_next_entry(connector, head))
1627 #define drm_for_each_encoder(encoder, dev) \
1628 list_for_each_entry(encoder, &(dev)->mode_config.encoder_list, head)
1630 #define drm_for_each_fb(fb, dev) \
1631 for (WARN_ON(!mutex_is_locked(&(dev)->mode_config.fb_lock)), \
1632 fb = list_first_entry(&(dev)->mode_config.fb_list, \
1633 struct drm_framebuffer, head); \
1634 &fb->head != (&(dev)->mode_config.fb_list); \
1635 fb = list_next_entry(fb, head))
1637 #endif /* __DRM_CRTC_H__ */