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
);
89 * Rotation property bits. DRM_ROTATE_<degrees> rotates the image by the
90 * specified amount in degrees in counter clockwise direction. DRM_REFLECT_X and
91 * DRM_REFLECT_Y reflects the image along the specified axis prior to rotation
93 #define DRM_ROTATE_MASK 0x0f
94 #define DRM_ROTATE_0 0
95 #define DRM_ROTATE_90 1
96 #define DRM_ROTATE_180 2
97 #define DRM_ROTATE_270 3
98 #define DRM_REFLECT_MASK (~DRM_ROTATE_MASK)
99 #define DRM_REFLECT_X 4
100 #define DRM_REFLECT_Y 5
102 enum drm_connector_force
{
103 DRM_FORCE_UNSPECIFIED
,
105 DRM_FORCE_ON
, /* force on analog part normally */
106 DRM_FORCE_ON_DIGITAL
, /* for DVI-I use digital connector */
109 #include <drm/drm_modes.h>
111 enum drm_connector_status
{
112 connector_status_connected
= 1,
113 connector_status_disconnected
= 2,
114 connector_status_unknown
= 3,
117 enum subpixel_order
{
119 SubPixelHorizontalRGB
,
120 SubPixelHorizontalBGR
,
126 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
127 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
128 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
130 * Describes a given display (e.g. CRT or flat panel) and its limitations.
132 struct drm_display_info
{
133 char name
[DRM_DISPLAY_INFO_LEN
];
136 unsigned int width_mm
;
137 unsigned int height_mm
;
139 /* Clock limits FIXME: storage format */
140 unsigned int min_vfreq
, max_vfreq
;
141 unsigned int min_hfreq
, max_hfreq
;
142 unsigned int pixel_clock
;
145 enum subpixel_order subpixel_order
;
148 const u32
*bus_formats
;
149 unsigned int num_bus_formats
;
151 /* Mask of supported hdmi deep color modes */
152 u8 edid_hdmi_dc_modes
;
157 /* data corresponds to displayid vend/prod/serial */
158 struct drm_tile_group
{
159 struct kref refcount
;
160 struct drm_device
*dev
;
165 struct drm_framebuffer_funcs
{
166 /* note: use drm_framebuffer_remove() */
167 void (*destroy
)(struct drm_framebuffer
*framebuffer
);
168 int (*create_handle
)(struct drm_framebuffer
*fb
,
169 struct drm_file
*file_priv
,
170 unsigned int *handle
);
172 * Optional callback for the dirty fb ioctl.
174 * Userspace can notify the driver via this callback
175 * that a area of the framebuffer has changed and should
176 * be flushed to the display hardware.
178 * See documentation in drm_mode.h for the struct
179 * drm_mode_fb_dirty_cmd for more information as all
180 * the semantics and arguments have a one to one mapping
183 int (*dirty
)(struct drm_framebuffer
*framebuffer
,
184 struct drm_file
*file_priv
, unsigned flags
,
185 unsigned color
, struct drm_clip_rect
*clips
,
189 struct drm_framebuffer
{
190 struct drm_device
*dev
;
192 * Note that the fb is refcounted for the benefit of driver internals,
193 * for example some hw, disabling a CRTC/plane is asynchronous, and
194 * scanout does not actually complete until the next vblank. So some
195 * cleanup (like releasing the reference(s) on the backing GEM bo(s))
196 * should be deferred. In cases like this, the driver would like to
197 * hold a ref to the fb even though it has already been removed from
198 * userspace perspective.
200 struct kref refcount
;
202 * Place on the dev->mode_config.fb_list, access protected by
203 * dev->mode_config.fb_lock.
205 struct list_head head
;
206 struct drm_mode_object base
;
207 const struct drm_framebuffer_funcs
*funcs
;
208 unsigned int pitches
[4];
209 unsigned int offsets
[4];
210 uint64_t modifier
[4];
213 /* depth can be 15 or 16 */
217 uint32_t pixel_format
; /* fourcc format */
218 struct list_head filp_head
;
221 struct drm_property_blob
{
222 struct drm_mode_object base
;
223 struct drm_device
*dev
;
224 struct kref refcount
;
225 struct list_head head_global
;
226 struct list_head head_file
;
228 unsigned char data
[];
231 struct drm_property_enum
{
233 struct list_head head
;
234 char name
[DRM_PROP_NAME_LEN
];
237 struct drm_property
{
238 struct list_head head
;
239 struct drm_mode_object base
;
241 char name
[DRM_PROP_NAME_LEN
];
244 struct drm_device
*dev
;
246 struct list_head enum_list
;
250 struct drm_connector
;
252 struct drm_pending_vblank_event
;
255 struct drm_atomic_state
;
257 struct drm_crtc_helper_funcs
;
258 struct drm_encoder_helper_funcs
;
259 struct drm_connector_helper_funcs
;
260 struct drm_plane_helper_funcs
;
263 * struct drm_crtc_state - mutable CRTC state
264 * @crtc: backpointer to the CRTC
265 * @enable: whether the CRTC should be enabled, gates all other state
266 * @active: whether the CRTC is actively displaying (used for DPMS)
267 * @planes_changed: planes on this crtc are updated
268 * @mode_changed: crtc_state->mode or crtc_state->enable has been changed
269 * @active_changed: crtc_state->active has been toggled.
270 * @connectors_changed: connectors to this crtc have been updated
271 * @plane_mask: bitmask of (1 << drm_plane_index(plane)) of attached planes
272 * @last_vblank_count: for helpers and drivers to capture the vblank of the
273 * update to ensure framebuffer cleanup isn't done too early
274 * @adjusted_mode: for use by helpers and drivers to compute adjusted mode timings
275 * @mode: current mode timings
276 * @event: optional pointer to a DRM event to signal upon completion of the
278 * @state: backpointer to global drm_atomic_state
280 * Note that the distinction between @enable and @active is rather subtile:
281 * Flipping @active while @enable is set without changing anything else may
282 * never return in a failure from the ->atomic_check callback. Userspace assumes
283 * that a DPMS On will always succeed. In other words: @enable controls resource
284 * assignment, @active controls the actual hardware state.
286 struct drm_crtc_state
{
287 struct drm_crtc
*crtc
;
292 /* computed state bits used by helpers and drivers */
293 bool planes_changed
: 1;
294 bool mode_changed
: 1;
295 bool active_changed
: 1;
296 bool connectors_changed
: 1;
298 /* attached planes bitmask:
299 * WARNING: transitional helpers do not maintain plane_mask so
300 * drivers not converted over to atomic helpers should not rely
301 * on plane_mask being accurate!
305 /* last_vblank_count: for vblank waits before cleanup */
306 u32 last_vblank_count
;
308 /* adjusted_mode: for use by helpers and drivers */
309 struct drm_display_mode adjusted_mode
;
311 struct drm_display_mode mode
;
313 /* blob property to expose current mode to atomic userspace */
314 struct drm_property_blob
*mode_blob
;
316 struct drm_pending_vblank_event
*event
;
318 struct drm_atomic_state
*state
;
322 * struct drm_crtc_funcs - control CRTCs for a given device
323 * @save: save CRTC state
324 * @restore: restore CRTC state
325 * @cursor_set: setup the cursor
326 * @cursor_set2: setup the cursor with hotspot, superseeds @cursor_set if set
327 * @cursor_move: move the cursor
328 * @gamma_set: specify color ramp for CRTC
329 * @set_config: apply a new CRTC configuration
330 * @page_flip: initiate a page flip
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? */
350 * Reset CRTC hardware and software state to off. This function isn't
351 * called by the core directly, only through drm_mode_config_reset().
352 * It's not a helper hook only for historical reasons.
354 * Atomic drivers can use drm_atomic_helper_crtc_reset() to reset
355 * atomic state using this hook.
357 void (*reset
)(struct drm_crtc
*crtc
);
359 /* cursor controls */
360 int (*cursor_set
)(struct drm_crtc
*crtc
, struct drm_file
*file_priv
,
361 uint32_t handle
, uint32_t width
, uint32_t height
);
362 int (*cursor_set2
)(struct drm_crtc
*crtc
, struct drm_file
*file_priv
,
363 uint32_t handle
, uint32_t width
, uint32_t height
,
364 int32_t hot_x
, int32_t hot_y
);
365 int (*cursor_move
)(struct drm_crtc
*crtc
, int x
, int y
);
367 /* Set gamma on the CRTC */
368 void (*gamma_set
)(struct drm_crtc
*crtc
, u16
*r
, u16
*g
, u16
*b
,
369 uint32_t start
, uint32_t size
);
374 * Clean up plane resources. This is only called at driver unload time
375 * through drm_mode_config_cleanup() since a CRTC cannot be hotplugged
378 void (*destroy
)(struct drm_crtc
*crtc
);
380 int (*set_config
)(struct drm_mode_set
*set
);
383 * Flip to the given framebuffer. This implements the page
384 * flip ioctl described in drm_mode.h, specifically, the
385 * implementation must return immediately and block all
386 * rendering to the current fb until the flip has completed.
387 * If userspace set the event flag in the ioctl, the event
388 * argument will point to an event to send back when the flip
389 * completes, otherwise it will be NULL.
391 int (*page_flip
)(struct drm_crtc
*crtc
,
392 struct drm_framebuffer
*fb
,
393 struct drm_pending_vblank_event
*event
,
399 * This is the legacy entry point to update a property attached to the
402 * Drivers implementing atomic modeset should use
403 * drm_atomic_helper_crtc_set_property() to implement this hook.
405 * This callback is optional if the driver does not support any legacy
406 * driver-private properties.
410 * 0 on success or a negative error code on failure.
412 int (*set_property
)(struct drm_crtc
*crtc
,
413 struct drm_property
*property
, uint64_t val
);
416 * @atomic_duplicate_state:
418 * Duplicate the current atomic state for this CRTC and return it.
419 * The core and helpers gurantee that any atomic state duplicated with
420 * this hook and still owned by the caller (i.e. not transferred to the
421 * driver by calling ->atomic_commit() from struct
422 * &drm_mode_config_funcs) will be cleaned up by calling the
423 * @atomic_destroy_state hook in this structure.
425 * Atomic drivers which don't subclass struct &drm_crtc should use
426 * drm_atomic_helper_crtc_duplicate_state(). Drivers that subclass the
427 * state structure to extend it with driver-private state should use
428 * __drm_atomic_helper_crtc_duplicate_state() to make sure shared state is
429 * duplicated in a consistent fashion across drivers.
431 * It is an error to call this hook before crtc->state has been
432 * initialized correctly.
436 * If the duplicate state references refcounted resources this hook must
437 * acquire a reference for each of them. The driver must release these
438 * references again in @atomic_destroy_state.
442 * Duplicated atomic state or NULL when the allocation failed.
444 struct drm_crtc_state
*(*atomic_duplicate_state
)(struct drm_crtc
*crtc
);
447 * @atomic_destroy_state:
449 * Destroy a state duplicated with @atomic_duplicate_state and release
450 * or unreference all resources it references
452 void (*atomic_destroy_state
)(struct drm_crtc
*crtc
,
453 struct drm_crtc_state
*state
);
456 * @atomic_set_property:
458 * Decode a driver-private property value and store the decoded value
459 * into the passed-in state structure. Since the atomic core decodes all
460 * standardized properties (even for extensions beyond the core set of
461 * properties which might not be implemented by all drivers) this
462 * requires drivers to subclass the state structure.
464 * Such driver-private properties should really only be implemented for
465 * truly hardware/vendor specific state. Instead it is preferred to
466 * standardize atomic extension and decode the properties used to expose
467 * such an extension in the core.
469 * Do not call this function directly, use
470 * drm_atomic_crtc_set_property() instead.
472 * This callback is optional if the driver does not support any
473 * driver-private atomic properties.
477 * This function is called in the state assembly phase of atomic
478 * modesets, which can be aborted for any reason (including on
479 * userspace's request to just check whether a configuration would be
480 * possible). Drivers MUST NOT touch any persistent state (hardware or
481 * software) or data structures except the passed in @state parameter.
483 * Also since userspace controls in which order properties are set this
484 * function must not do any input validation (since the state update is
485 * incomplete and hence likely inconsistent). Instead any such input
486 * validation must be done in the various atomic_check callbacks.
490 * 0 if the property has been found, -EINVAL if the property isn't
491 * implemented by the driver (which should never happen, the core only
492 * asks for properties attached to this CRTC). No other validation is
493 * allowed by the driver. The core already checks that the property
494 * value is within the range (integer, valid enum value, ...) the driver
495 * set when registering the property.
497 int (*atomic_set_property
)(struct drm_crtc
*crtc
,
498 struct drm_crtc_state
*state
,
499 struct drm_property
*property
,
502 * @atomic_get_property:
504 * Reads out the decoded driver-private property. This is used to
505 * implement the GETCRTC ioctl.
507 * Do not call this function directly, use
508 * drm_atomic_crtc_get_property() instead.
510 * This callback is optional if the driver does not support any
511 * driver-private atomic properties.
515 * 0 on success, -EINVAL if the property isn't implemented by the
516 * driver (which should never happen, the core only asks for
517 * properties attached to this CRTC).
519 int (*atomic_get_property
)(struct drm_crtc
*crtc
,
520 const struct drm_crtc_state
*state
,
521 struct drm_property
*property
,
526 * struct drm_crtc - central CRTC control structure
527 * @dev: parent DRM device
528 * @port: OF node used by drm_of_find_possible_crtcs()
529 * @head: list management
530 * @mutex: per-CRTC locking
531 * @base: base KMS object for ID tracking etc.
532 * @primary: primary plane for this CRTC
533 * @cursor: cursor plane for this CRTC
534 * @cursor_x: current x position of the cursor, used for universal cursor planes
535 * @cursor_y: current y position of the cursor, used for universal cursor planes
536 * @enabled: is this CRTC enabled?
537 * @mode: current mode timings
538 * @hwmode: mode timings as programmed to hw regs
539 * @x: x position on screen
540 * @y: y position on screen
541 * @funcs: CRTC control functions
542 * @gamma_size: size of gamma ramp
543 * @gamma_store: gamma ramp values
544 * @helper_private: mid-layer private data
545 * @properties: property tracking for this CRTC
546 * @state: current atomic state for this CRTC
547 * @acquire_ctx: per-CRTC implicit acquire context used by atomic drivers for
550 * Each CRTC may have one or more connectors associated with it. This structure
551 * allows the CRTC to be controlled.
554 struct drm_device
*dev
;
555 struct device_node
*port
;
556 struct list_head head
;
561 * This provides a read lock for the overall crtc state (mode, dpms
562 * state, ...) and a write lock for everything which can be update
563 * without a full modeset (fb, cursor data, ...)
565 struct drm_modeset_lock mutex
;
567 struct drm_mode_object base
;
569 /* primary and cursor planes for CRTC */
570 struct drm_plane
*primary
;
571 struct drm_plane
*cursor
;
573 /* position of cursor plane on crtc */
579 /* Requested mode from modesetting. */
580 struct drm_display_mode mode
;
582 /* Programmed mode in hw, after adjustments for encoders,
583 * crtc, panel scaling etc. Needed for timestamping etc.
585 struct drm_display_mode hwmode
;
588 const struct drm_crtc_funcs
*funcs
;
590 /* CRTC gamma size for reporting to userspace */
592 uint16_t *gamma_store
;
594 /* if you are using the helper */
595 const struct drm_crtc_helper_funcs
*helper_private
;
597 struct drm_object_properties properties
;
599 struct drm_crtc_state
*state
;
602 * For legacy crtc ioctls so that atomic drivers can get at the locking
605 struct drm_modeset_acquire_ctx
*acquire_ctx
;
609 * struct drm_connector_state - mutable connector state
610 * @connector: backpointer to the connector
611 * @crtc: CRTC to connect connector to, NULL if disabled
612 * @best_encoder: can be used by helpers and drivers to select the encoder
613 * @state: backpointer to global drm_atomic_state
615 struct drm_connector_state
{
616 struct drm_connector
*connector
;
618 struct drm_crtc
*crtc
; /* do not write directly, use drm_atomic_set_crtc_for_connector() */
620 struct drm_encoder
*best_encoder
;
622 struct drm_atomic_state
*state
;
626 * struct drm_connector_funcs - control connectors on a given device
627 * @dpms: set power state
628 * @save: save connector state
629 * @restore: restore connector state
630 * @detect: is this connector active?
631 * @fill_modes: fill mode list for this connector
632 * @force: notify the driver that the connector is forced on
634 * Each CRTC may have one or more connectors attached to it. The functions
635 * below allow the core DRM code to control connectors, enumerate available modes,
638 struct drm_connector_funcs
{
639 int (*dpms
)(struct drm_connector
*connector
, int mode
);
640 void (*save
)(struct drm_connector
*connector
);
641 void (*restore
)(struct drm_connector
*connector
);
646 * Reset connector hardware and software state to off. This function isn't
647 * called by the core directly, only through drm_mode_config_reset().
648 * It's not a helper hook only for historical reasons.
650 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset
651 * atomic state using this hook.
653 void (*reset
)(struct drm_connector
*connector
);
655 /* Check to see if anything is attached to the connector.
656 * @force is set to false whilst polling, true when checking the
657 * connector due to user request. @force can be used by the driver
658 * to avoid expensive, destructive operations during automated
661 enum drm_connector_status (*detect
)(struct drm_connector
*connector
,
663 int (*fill_modes
)(struct drm_connector
*connector
, uint32_t max_width
, uint32_t max_height
);
668 * This is the legacy entry point to update a property attached to the
671 * Drivers implementing atomic modeset should use
672 * drm_atomic_helper_connector_set_property() to implement this hook.
674 * This callback is optional if the driver does not support any legacy
675 * driver-private properties.
679 * 0 on success or a negative error code on failure.
681 int (*set_property
)(struct drm_connector
*connector
, struct drm_property
*property
,
687 * Clean up connector resources. This is called at driver unload time
688 * through drm_mode_config_cleanup(). It can also be called at runtime
689 * when a connector is being hot-unplugged for drivers that support
690 * connector hotplugging (e.g. DisplayPort MST).
692 void (*destroy
)(struct drm_connector
*connector
);
693 void (*force
)(struct drm_connector
*connector
);
696 * @atomic_duplicate_state:
698 * Duplicate the current atomic state for this connector and return it.
699 * The core and helpers gurantee that any atomic state duplicated with
700 * this hook and still owned by the caller (i.e. not transferred to the
701 * driver by calling ->atomic_commit() from struct
702 * &drm_mode_config_funcs) will be cleaned up by calling the
703 * @atomic_destroy_state hook in this structure.
705 * Atomic drivers which don't subclass struct &drm_connector_state should use
706 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the
707 * state structure to extend it with driver-private state should use
708 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is
709 * duplicated in a consistent fashion across drivers.
711 * It is an error to call this hook before connector->state has been
712 * initialized correctly.
716 * If the duplicate state references refcounted resources this hook must
717 * acquire a reference for each of them. The driver must release these
718 * references again in @atomic_destroy_state.
722 * Duplicated atomic state or NULL when the allocation failed.
724 struct drm_connector_state
*(*atomic_duplicate_state
)(struct drm_connector
*connector
);
727 * @atomic_destroy_state:
729 * Destroy a state duplicated with @atomic_duplicate_state and release
730 * or unreference all resources it references
732 void (*atomic_destroy_state
)(struct drm_connector
*connector
,
733 struct drm_connector_state
*state
);
736 * @atomic_set_property:
738 * Decode a driver-private property value and store the decoded value
739 * into the passed-in state structure. Since the atomic core decodes all
740 * standardized properties (even for extensions beyond the core set of
741 * properties which might not be implemented by all drivers) this
742 * requires drivers to subclass the state structure.
744 * Such driver-private properties should really only be implemented for
745 * truly hardware/vendor specific state. Instead it is preferred to
746 * standardize atomic extension and decode the properties used to expose
747 * such an extension in the core.
749 * Do not call this function directly, use
750 * drm_atomic_connector_set_property() instead.
752 * This callback is optional if the driver does not support any
753 * driver-private atomic properties.
757 * This function is called in the state assembly phase of atomic
758 * modesets, which can be aborted for any reason (including on
759 * userspace's request to just check whether a configuration would be
760 * possible). Drivers MUST NOT touch any persistent state (hardware or
761 * software) or data structures except the passed in @state parameter.
763 * Also since userspace controls in which order properties are set this
764 * function must not do any input validation (since the state update is
765 * incomplete and hence likely inconsistent). Instead any such input
766 * validation must be done in the various atomic_check callbacks.
770 * 0 if the property has been found, -EINVAL if the property isn't
771 * implemented by the driver (which shouldn't ever happen, the core only
772 * asks for properties attached to this connector). No other validation
773 * is allowed by the driver. The core already checks that the property
774 * value is within the range (integer, valid enum value, ...) the driver
775 * set when registering the property.
777 int (*atomic_set_property
)(struct drm_connector
*connector
,
778 struct drm_connector_state
*state
,
779 struct drm_property
*property
,
783 * @atomic_get_property:
785 * Reads out the decoded driver-private property. This is used to
786 * implement the GETCONNECTOR ioctl.
788 * Do not call this function directly, use
789 * drm_atomic_connector_get_property() instead.
791 * This callback is optional if the driver does not support any
792 * driver-private atomic properties.
796 * 0 on success, -EINVAL if the property isn't implemented by the
797 * driver (which shouldn't ever happen, the core only asks for
798 * properties attached to this connector).
800 int (*atomic_get_property
)(struct drm_connector
*connector
,
801 const struct drm_connector_state
*state
,
802 struct drm_property
*property
,
807 * struct drm_encoder_funcs - encoder controls
809 * Encoders sit between CRTCs and connectors.
811 struct drm_encoder_funcs
{
815 * Reset encoder hardware and software state to off. This function isn't
816 * called by the core directly, only through drm_mode_config_reset().
817 * It's not a helper hook only for historical reasons.
819 void (*reset
)(struct drm_encoder
*encoder
);
824 * Clean up encoder resources. This is only called at driver unload time
825 * through drm_mode_config_cleanup() since an encoder cannot be
828 void (*destroy
)(struct drm_encoder
*encoder
);
831 #define DRM_CONNECTOR_MAX_ENCODER 3
834 * struct drm_encoder - central DRM encoder structure
835 * @dev: parent DRM device
836 * @head: list management
837 * @base: base KMS object
838 * @name: encoder name
839 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
840 * @possible_crtcs: bitmask of potential CRTC bindings
841 * @possible_clones: bitmask of potential sibling encoders for cloning
842 * @crtc: currently bound CRTC
843 * @bridge: bridge associated to the encoder
844 * @funcs: control functions
845 * @helper_private: mid-layer private data
847 * CRTCs drive pixels to encoders, which convert them into signals
848 * appropriate for a given connector or set of connectors.
851 struct drm_device
*dev
;
852 struct list_head head
;
854 struct drm_mode_object base
;
857 uint32_t possible_crtcs
;
858 uint32_t possible_clones
;
860 struct drm_crtc
*crtc
;
861 struct drm_bridge
*bridge
;
862 const struct drm_encoder_funcs
*funcs
;
863 const struct drm_encoder_helper_funcs
*helper_private
;
866 /* should we poll this connector for connects and disconnects */
867 /* hot plug detectable */
868 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
869 /* poll for connections */
870 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
871 /* can cleanly poll for disconnections without flickering the screen */
872 /* DACs should rarely do this without a lot of testing */
873 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
875 #define MAX_ELD_BYTES 128
878 * struct drm_connector - central DRM connector control structure
879 * @dev: parent DRM device
880 * @kdev: kernel device for sysfs attributes
881 * @attr: sysfs attributes
882 * @head: list management
883 * @base: base KMS object
884 * @name: connector name
885 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
886 * @connector_type_id: index into connector type enum
887 * @interlace_allowed: can this connector handle interlaced modes?
888 * @doublescan_allowed: can this connector handle doublescan?
889 * @stereo_allowed: can this connector handle stereo modes?
890 * @modes: modes available on this connector (from fill_modes() + user)
891 * @status: one of the drm_connector_status enums (connected, not, or unknown)
892 * @probed_modes: list of modes derived directly from the display
893 * @display_info: information about attached display (e.g. from EDID)
894 * @funcs: connector control functions
895 * @edid_blob_ptr: DRM property containing EDID if present
896 * @properties: property tracking for this connector
897 * @path_blob_ptr: DRM blob property data for the DP MST path property
898 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
899 * @dpms: current dpms state
900 * @helper_private: mid-layer private data
901 * @cmdline_mode: mode line parsed from the kernel cmdline for this connector
902 * @force: a %DRM_FORCE_<foo> state for forced mode sets
903 * @override_edid: has the EDID been overwritten through debugfs for testing?
904 * @encoder_ids: valid encoders for this connector
905 * @encoder: encoder driving this connector, if any
906 * @eld: EDID-like data, if present
907 * @dvi_dual: dual link DVI, if found
908 * @max_tmds_clock: max clock rate, if found
909 * @latency_present: AV delay info from ELD, if found
910 * @video_latency: video latency info from ELD, if found
911 * @audio_latency: audio latency info from ELD, if found
912 * @null_edid_counter: track sinks that give us all zeros for the EDID
913 * @bad_edid_counter: track sinks that give us an EDID with invalid checksum
914 * @edid_corrupt: indicates whether the last read EDID was corrupt
915 * @debugfs_entry: debugfs directory for this connector
916 * @state: current atomic state for this connector
917 * @has_tile: is this connector connected to a tiled monitor
918 * @tile_group: tile group for the connected monitor
919 * @tile_is_single_monitor: whether the tile is one monitor housing
920 * @num_h_tile: number of horizontal tiles in the tile group
921 * @num_v_tile: number of vertical tiles in the tile group
922 * @tile_h_loc: horizontal location of this tile
923 * @tile_v_loc: vertical location of this tile
924 * @tile_h_size: horizontal size of this tile.
925 * @tile_v_size: vertical size of this tile.
927 * Each connector may be connected to one or more CRTCs, or may be clonable by
928 * another connector if they can share a CRTC. Each connector also has a specific
929 * position in the broader display (referred to as a 'screen' though it could
930 * span multiple monitors).
932 struct drm_connector
{
933 struct drm_device
*dev
;
935 struct device_attribute
*attr
;
936 struct list_head head
;
938 struct drm_mode_object base
;
942 int connector_type_id
;
943 bool interlace_allowed
;
944 bool doublescan_allowed
;
946 struct list_head modes
; /* list of modes on this connector */
948 enum drm_connector_status status
;
950 /* these are modes added by probing with DDC or the BIOS */
951 struct list_head probed_modes
;
953 struct drm_display_info display_info
;
954 const struct drm_connector_funcs
*funcs
;
956 struct drm_property_blob
*edid_blob_ptr
;
957 struct drm_object_properties properties
;
959 struct drm_property_blob
*path_blob_ptr
;
961 struct drm_property_blob
*tile_blob_ptr
;
963 uint8_t polled
; /* DRM_CONNECTOR_POLL_* */
965 /* requested DPMS state */
968 const struct drm_connector_helper_funcs
*helper_private
;
970 /* forced on connector */
971 struct drm_cmdline_mode cmdline_mode
;
972 enum drm_connector_force force
;
974 uint32_t encoder_ids
[DRM_CONNECTOR_MAX_ENCODER
];
975 struct drm_encoder
*encoder
; /* currently active encoder */
978 uint8_t eld
[MAX_ELD_BYTES
];
980 int max_tmds_clock
; /* in MHz */
981 bool latency_present
[2];
982 int video_latency
[2]; /* [0]: progressive, [1]: interlaced */
983 int audio_latency
[2];
984 int null_edid_counter
; /* needed to workaround some HW bugs where we get all 0s */
985 unsigned bad_edid_counter
;
987 /* Flag for raw EDID header corruption - used in Displayport
988 * compliance testing - * Displayport Link CTS Core 1.2 rev1.1 4.2.2.6
992 struct dentry
*debugfs_entry
;
994 struct drm_connector_state
*state
;
998 struct drm_tile_group
*tile_group
;
999 bool tile_is_single_monitor
;
1001 uint8_t num_h_tile
, num_v_tile
;
1002 uint8_t tile_h_loc
, tile_v_loc
;
1003 uint16_t tile_h_size
, tile_v_size
;
1007 * struct drm_plane_state - mutable plane state
1008 * @plane: backpointer to the plane
1009 * @crtc: currently bound CRTC, NULL if disabled
1010 * @fb: currently bound framebuffer
1011 * @fence: optional fence to wait for before scanning out @fb
1012 * @crtc_x: left position of visible portion of plane on crtc
1013 * @crtc_y: upper position of visible portion of plane on crtc
1014 * @crtc_w: width of visible portion of plane on crtc
1015 * @crtc_h: height of visible portion of plane on crtc
1016 * @src_x: left position of visible portion of plane within
1018 * @src_y: upper position of visible portion of plane within
1020 * @src_w: width of visible portion of plane (in 16.16)
1021 * @src_h: height of visible portion of plane (in 16.16)
1022 * @state: backpointer to global drm_atomic_state
1024 struct drm_plane_state
{
1025 struct drm_plane
*plane
;
1027 struct drm_crtc
*crtc
; /* do not write directly, use drm_atomic_set_crtc_for_plane() */
1028 struct drm_framebuffer
*fb
; /* do not write directly, use drm_atomic_set_fb_for_plane() */
1029 struct fence
*fence
;
1031 /* Signed dest location allows it to be partially off screen */
1032 int32_t crtc_x
, crtc_y
;
1033 uint32_t crtc_w
, crtc_h
;
1035 /* Source values are 16.16 fixed point */
1036 uint32_t src_x
, src_y
;
1037 uint32_t src_h
, src_w
;
1039 /* Plane rotation */
1040 unsigned int rotation
;
1042 struct drm_atomic_state
*state
;
1047 * struct drm_plane_funcs - driver plane control functions
1049 struct drm_plane_funcs
{
1053 * This is the legacy entry point to enable and configure the plane for
1054 * the given CRTC and framebuffer. It is never called to disable the
1055 * plane, i.e. the passed-in crtc and fb paramters are never NULL.
1057 * The source rectangle in frame buffer memory coordinates is given by
1058 * the src_x, src_y, src_w and src_h parameters (as 16.16 fixed point
1059 * values). Devices that don't support subpixel plane coordinates can
1060 * ignore the fractional part.
1062 * The destination rectangle in CRTC coordinates is given by the
1063 * crtc_x, crtc_y, crtc_w and crtc_h parameters (as integer values).
1064 * Devices scale the source rectangle to the destination rectangle. If
1065 * scaling is not supported, and the source rectangle size doesn't match
1066 * the destination rectangle size, the driver must return a
1067 * -<errorname>EINVAL</errorname> error.
1069 * Drivers implementing atomic modeset should use
1070 * drm_atomic_helper_update_plane() to implement this hook.
1074 * 0 on success or a negative error code on failure.
1076 int (*update_plane
)(struct drm_plane
*plane
,
1077 struct drm_crtc
*crtc
, struct drm_framebuffer
*fb
,
1078 int crtc_x
, int crtc_y
,
1079 unsigned int crtc_w
, unsigned int crtc_h
,
1080 uint32_t src_x
, uint32_t src_y
,
1081 uint32_t src_w
, uint32_t src_h
);
1086 * This is the legacy entry point to disable the plane. The DRM core
1087 * calls this method in response to a DRM_IOCTL_MODE_SETPLANE ioctl call
1088 * with the frame buffer ID set to 0. Disabled planes must not be
1089 * processed by the CRTC.
1091 * Drivers implementing atomic modeset should use
1092 * drm_atomic_helper_disable_plane() to implement this hook.
1096 * 0 on success or a negative error code on failure.
1098 int (*disable_plane
)(struct drm_plane
*plane
);
1103 * Clean up plane resources. This is only called at driver unload time
1104 * through drm_mode_config_cleanup() since a plane cannot be hotplugged
1107 void (*destroy
)(struct drm_plane
*plane
);
1112 * Reset plane hardware and software state to off. This function isn't
1113 * called by the core directly, only through drm_mode_config_reset().
1114 * It's not a helper hook only for historical reasons.
1116 * Atomic drivers can use drm_atomic_helper_plane_reset() to reset
1117 * atomic state using this hook.
1119 void (*reset
)(struct drm_plane
*plane
);
1124 * This is the legacy entry point to update a property attached to the
1127 * Drivers implementing atomic modeset should use
1128 * drm_atomic_helper_plane_set_property() to implement this hook.
1130 * This callback is optional if the driver does not support any legacy
1131 * driver-private properties.
1135 * 0 on success or a negative error code on failure.
1137 int (*set_property
)(struct drm_plane
*plane
,
1138 struct drm_property
*property
, uint64_t val
);
1141 * @atomic_duplicate_state:
1143 * Duplicate the current atomic state for this plane and return it.
1144 * The core and helpers gurantee that any atomic state duplicated with
1145 * this hook and still owned by the caller (i.e. not transferred to the
1146 * driver by calling ->atomic_commit() from struct
1147 * &drm_mode_config_funcs) will be cleaned up by calling the
1148 * @atomic_destroy_state hook in this structure.
1150 * Atomic drivers which don't subclass struct &drm_plane_state should use
1151 * drm_atomic_helper_plane_duplicate_state(). Drivers that subclass the
1152 * state structure to extend it with driver-private state should use
1153 * __drm_atomic_helper_plane_duplicate_state() to make sure shared state is
1154 * duplicated in a consistent fashion across drivers.
1156 * It is an error to call this hook before plane->state has been
1157 * initialized correctly.
1161 * If the duplicate state references refcounted resources this hook must
1162 * acquire a reference for each of them. The driver must release these
1163 * references again in @atomic_destroy_state.
1167 * Duplicated atomic state or NULL when the allocation failed.
1169 struct drm_plane_state
*(*atomic_duplicate_state
)(struct drm_plane
*plane
);
1172 * @atomic_destroy_state:
1174 * Destroy a state duplicated with @atomic_duplicate_state and release
1175 * or unreference all resources it references
1177 void (*atomic_destroy_state
)(struct drm_plane
*plane
,
1178 struct drm_plane_state
*state
);
1181 * @atomic_set_property:
1183 * Decode a driver-private property value and store the decoded value
1184 * into the passed-in state structure. Since the atomic core decodes all
1185 * standardized properties (even for extensions beyond the core set of
1186 * properties which might not be implemented by all drivers) this
1187 * requires drivers to subclass the state structure.
1189 * Such driver-private properties should really only be implemented for
1190 * truly hardware/vendor specific state. Instead it is preferred to
1191 * standardize atomic extension and decode the properties used to expose
1192 * such an extension in the core.
1194 * Do not call this function directly, use
1195 * drm_atomic_plane_set_property() instead.
1197 * This callback is optional if the driver does not support any
1198 * driver-private atomic properties.
1202 * This function is called in the state assembly phase of atomic
1203 * modesets, which can be aborted for any reason (including on
1204 * userspace's request to just check whether a configuration would be
1205 * possible). Drivers MUST NOT touch any persistent state (hardware or
1206 * software) or data structures except the passed in @state parameter.
1208 * Also since userspace controls in which order properties are set this
1209 * function must not do any input validation (since the state update is
1210 * incomplete and hence likely inconsistent). Instead any such input
1211 * validation must be done in the various atomic_check callbacks.
1215 * 0 if the property has been found, -EINVAL if the property isn't
1216 * implemented by the driver (which shouldn't ever happen, the core only
1217 * asks for properties attached to this plane). No other validation is
1218 * allowed by the driver. The core already checks that the property
1219 * value is within the range (integer, valid enum value, ...) the driver
1220 * set when registering the property.
1222 int (*atomic_set_property
)(struct drm_plane
*plane
,
1223 struct drm_plane_state
*state
,
1224 struct drm_property
*property
,
1228 * @atomic_get_property:
1230 * Reads out the decoded driver-private property. This is used to
1231 * implement the GETPLANE ioctl.
1233 * Do not call this function directly, use
1234 * drm_atomic_plane_get_property() instead.
1236 * This callback is optional if the driver does not support any
1237 * driver-private atomic properties.
1241 * 0 on success, -EINVAL if the property isn't implemented by the
1242 * driver (which should never happen, the core only asks for
1243 * properties attached to this plane).
1245 int (*atomic_get_property
)(struct drm_plane
*plane
,
1246 const struct drm_plane_state
*state
,
1247 struct drm_property
*property
,
1251 enum drm_plane_type
{
1252 DRM_PLANE_TYPE_OVERLAY
,
1253 DRM_PLANE_TYPE_PRIMARY
,
1254 DRM_PLANE_TYPE_CURSOR
,
1259 * struct drm_plane - central DRM plane control structure
1260 * @dev: DRM device this plane belongs to
1261 * @head: for list management
1262 * @base: base mode object
1263 * @possible_crtcs: pipes this plane can be bound to
1264 * @format_types: array of formats supported by this plane
1265 * @format_count: number of formats supported
1266 * @format_default: driver hasn't supplied supported formats for the plane
1267 * @crtc: currently bound CRTC
1268 * @fb: currently bound fb
1269 * @old_fb: Temporary tracking of the old fb while a modeset is ongoing. Used by
1270 * drm_mode_set_config_internal() to implement correct refcounting.
1271 * @funcs: helper functions
1272 * @properties: property tracking for this plane
1273 * @type: type of plane (overlay, primary, cursor)
1274 * @state: current atomic state for this plane
1277 struct drm_device
*dev
;
1278 struct list_head head
;
1280 struct drm_modeset_lock mutex
;
1282 struct drm_mode_object base
;
1284 uint32_t possible_crtcs
;
1285 uint32_t *format_types
;
1286 unsigned int format_count
;
1287 bool format_default
;
1289 struct drm_crtc
*crtc
;
1290 struct drm_framebuffer
*fb
;
1292 struct drm_framebuffer
*old_fb
;
1294 const struct drm_plane_funcs
*funcs
;
1296 struct drm_object_properties properties
;
1298 enum drm_plane_type type
;
1300 const struct drm_plane_helper_funcs
*helper_private
;
1302 struct drm_plane_state
*state
;
1306 * struct drm_bridge_funcs - drm_bridge control functions
1307 * @attach: Called during drm_bridge_attach
1309 struct drm_bridge_funcs
{
1310 int (*attach
)(struct drm_bridge
*bridge
);
1315 * This callback is used to validate and adjust a mode. The paramater
1316 * mode is the display mode that should be fed to the next element in
1317 * the display chain, either the final &drm_connector or the next
1318 * &drm_bridge. The parameter adjusted_mode is the input mode the bridge
1319 * requires. It can be modified by this callback and does not need to
1322 * This is the only hook that allows a bridge to reject a modeset. If
1323 * this function passes all other callbacks must succeed for this
1328 * This function is called in the check phase of atomic modesets, which
1329 * can be aborted for any reason (including on userspace's request to
1330 * just check whether a configuration would be possible). Drivers MUST
1331 * NOT touch any persistent state (hardware or software) or data
1332 * structures except the passed in @state parameter.
1336 * True if an acceptable configuration is possible, false if the modeset
1337 * operation should be rejected.
1339 bool (*mode_fixup
)(struct drm_bridge
*bridge
,
1340 const struct drm_display_mode
*mode
,
1341 struct drm_display_mode
*adjusted_mode
);
1345 * This callback should disable the bridge. It is called right before
1346 * the preceding element in the display pipe is disabled. If the
1347 * preceding element is a bridge this means it's called before that
1348 * bridge's ->disable() function. If the preceding element is a
1349 * &drm_encoder it's called right before the encoder's ->disable(),
1350 * ->prepare() or ->dpms() hook from struct &drm_encoder_helper_funcs.
1352 * The bridge can assume that the display pipe (i.e. clocks and timing
1353 * signals) feeding it is still running when this callback is called.
1355 void (*disable
)(struct drm_bridge
*bridge
);
1360 * This callback should disable the bridge. It is called right after
1361 * the preceding element in the display pipe is disabled. If the
1362 * preceding element is a bridge this means it's called after that
1363 * bridge's ->post_disable() function. If the preceding element is a
1364 * &drm_encoder it's called right after the encoder's ->disable(),
1365 * ->prepare() or ->dpms() hook from struct &drm_encoder_helper_funcs.
1367 * The bridge must assume that the display pipe (i.e. clocks and timing
1368 * singals) feeding it is no longer running when this callback is
1371 void (*post_disable
)(struct drm_bridge
*bridge
);
1376 * This callback should set the given mode on the bridge. It is called
1377 * after the ->mode_set() callback for the preceding element in the
1378 * display pipeline has been called already. The display pipe (i.e.
1379 * clocks and timing signals) is off when this function is called.
1381 void (*mode_set
)(struct drm_bridge
*bridge
,
1382 struct drm_display_mode
*mode
,
1383 struct drm_display_mode
*adjusted_mode
);
1387 * This callback should enable the bridge. It is called right before
1388 * the preceding element in the display pipe is enabled. If the
1389 * preceding element is a bridge this means it's called before that
1390 * bridge's ->pre_enable() function. If the preceding element is a
1391 * &drm_encoder it's called right before the encoder's ->enable(),
1392 * ->commit() or ->dpms() hook from struct &drm_encoder_helper_funcs.
1394 * The display pipe (i.e. clocks and timing signals) feeding this bridge
1395 * will not yet be running when this callback is called. The bridge must
1396 * not enable the display link feeding the next bridge in the chain (if
1397 * there is one) when this callback is called.
1399 void (*pre_enable
)(struct drm_bridge
*bridge
);
1404 * This callback should enable the bridge. It is called right after
1405 * the preceding element in the display pipe is enabled. If the
1406 * preceding element is a bridge this means it's called after that
1407 * bridge's ->enable() function. If the preceding element is a
1408 * &drm_encoder it's called right after the encoder's ->enable(),
1409 * ->commit() or ->dpms() hook from struct &drm_encoder_helper_funcs.
1411 * The bridge can assume that the display pipe (i.e. clocks and timing
1412 * signals) feeding it is running when this callback is called. This
1413 * callback must enable the display link feeding the next bridge in the
1414 * chain if there is one.
1416 void (*enable
)(struct drm_bridge
*bridge
);
1420 * struct drm_bridge - central DRM bridge control structure
1421 * @dev: DRM device this bridge belongs to
1422 * @encoder: encoder to which this bridge is connected
1423 * @next: the next bridge in the encoder chain
1424 * @of_node: device node pointer to the bridge
1425 * @list: to keep track of all added bridges
1426 * @funcs: control functions
1427 * @driver_private: pointer to the bridge driver's internal context
1430 struct drm_device
*dev
;
1431 struct drm_encoder
*encoder
;
1432 struct drm_bridge
*next
;
1434 struct device_node
*of_node
;
1436 struct list_head list
;
1438 const struct drm_bridge_funcs
*funcs
;
1439 void *driver_private
;
1443 * struct drm_atomic_state - the global state object for atomic updates
1444 * @dev: parent DRM device
1445 * @allow_modeset: allow full modeset
1446 * @legacy_cursor_update: hint to enforce legacy cursor ioctl semantics
1447 * @planes: pointer to array of plane pointers
1448 * @plane_states: pointer to array of plane states pointers
1449 * @crtcs: pointer to array of CRTC pointers
1450 * @crtc_states: pointer to array of CRTC states pointers
1451 * @num_connector: size of the @connectors and @connector_states arrays
1452 * @connectors: pointer to array of connector pointers
1453 * @connector_states: pointer to array of connector states pointers
1454 * @acquire_ctx: acquire context for this atomic modeset state update
1456 struct drm_atomic_state
{
1457 struct drm_device
*dev
;
1458 bool allow_modeset
: 1;
1459 bool legacy_cursor_update
: 1;
1460 struct drm_plane
**planes
;
1461 struct drm_plane_state
**plane_states
;
1462 struct drm_crtc
**crtcs
;
1463 struct drm_crtc_state
**crtc_states
;
1465 struct drm_connector
**connectors
;
1466 struct drm_connector_state
**connector_states
;
1468 struct drm_modeset_acquire_ctx
*acquire_ctx
;
1473 * struct drm_mode_set - new values for a CRTC config change
1474 * @fb: framebuffer to use for new config
1475 * @crtc: CRTC whose configuration we're about to change
1476 * @mode: mode timings to use
1477 * @x: position of this CRTC relative to @fb
1478 * @y: position of this CRTC relative to @fb
1479 * @connectors: array of connectors to drive with this CRTC if possible
1480 * @num_connectors: size of @connectors array
1482 * Represents a single crtc the connectors that it drives with what mode
1483 * and from which framebuffer it scans out from.
1485 * This is used to set modes.
1487 struct drm_mode_set
{
1488 struct drm_framebuffer
*fb
;
1489 struct drm_crtc
*crtc
;
1490 struct drm_display_mode
*mode
;
1495 struct drm_connector
**connectors
;
1496 size_t num_connectors
;
1500 * struct drm_mode_config_funcs - basic driver provided mode setting functions
1501 * @fb_create: create a new framebuffer object
1502 * @output_poll_changed: function to handle output configuration changes
1503 * @atomic_check: check whether a given atomic state update is possible
1504 * @atomic_commit: commit an atomic state update previously verified with
1506 * @atomic_state_alloc: allocate a new atomic state
1507 * @atomic_state_clear: clear the atomic state
1508 * @atomic_state_free: free the atomic state
1510 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
1513 struct drm_mode_config_funcs
{
1514 struct drm_framebuffer
*(*fb_create
)(struct drm_device
*dev
,
1515 struct drm_file
*file_priv
,
1516 const struct drm_mode_fb_cmd2
*mode_cmd
);
1517 void (*output_poll_changed
)(struct drm_device
*dev
);
1519 int (*atomic_check
)(struct drm_device
*dev
,
1520 struct drm_atomic_state
*a
);
1521 int (*atomic_commit
)(struct drm_device
*dev
,
1522 struct drm_atomic_state
*a
,
1524 struct drm_atomic_state
*(*atomic_state_alloc
)(struct drm_device
*dev
);
1525 void (*atomic_state_clear
)(struct drm_atomic_state
*state
);
1526 void (*atomic_state_free
)(struct drm_atomic_state
*state
);
1530 * struct drm_mode_config - Mode configuration control structure
1531 * @mutex: mutex protecting KMS related lists and structures
1532 * @connection_mutex: ww mutex protecting connector state and routing
1533 * @acquire_ctx: global implicit acquire context used by atomic drivers for
1535 * @idr_mutex: mutex for KMS ID allocation and management
1536 * @crtc_idr: main KMS ID tracking object
1537 * @fb_lock: mutex to protect fb state and lists
1538 * @num_fb: number of fbs available
1539 * @fb_list: list of framebuffers available
1540 * @num_connector: number of connectors on this device
1541 * @connector_list: list of connector objects
1542 * @num_encoder: number of encoders on this device
1543 * @encoder_list: list of encoder objects
1544 * @num_overlay_plane: number of overlay planes on this device
1545 * @num_total_plane: number of universal (i.e. with primary/curso) planes on this device
1546 * @plane_list: list of plane objects
1547 * @num_crtc: number of CRTCs on this device
1548 * @crtc_list: list of CRTC objects
1549 * @property_list: list of property objects
1550 * @min_width: minimum pixel width on this device
1551 * @min_height: minimum pixel height on this device
1552 * @max_width: maximum pixel width on this device
1553 * @max_height: maximum pixel height on this device
1554 * @funcs: core driver provided mode setting functions
1555 * @fb_base: base address of the framebuffer
1556 * @poll_enabled: track polling support for this device
1557 * @poll_running: track polling status for this device
1558 * @output_poll_work: delayed work for polling in process context
1559 * @property_blob_list: list of all the blob property objects
1560 * @blob_lock: mutex for blob property allocation and management
1561 * @*_property: core property tracking
1562 * @preferred_depth: preferred RBG pixel depth, used by fb helpers
1563 * @prefer_shadow: hint to userspace to prefer shadow-fb rendering
1564 * @async_page_flip: does this device support async flips on the primary plane?
1565 * @cursor_width: hint to userspace for max cursor width
1566 * @cursor_height: hint to userspace for max cursor height
1568 * Core mode resource tracking structure. All CRTC, encoders, and connectors
1569 * enumerated by the driver are added here, as are global properties. Some
1570 * global restrictions are also here, e.g. dimension restrictions.
1572 struct drm_mode_config
{
1573 struct mutex mutex
; /* protects configuration (mode lists etc.) */
1574 struct drm_modeset_lock connection_mutex
; /* protects connector->encoder and encoder->crtc links */
1575 struct drm_modeset_acquire_ctx
*acquire_ctx
; /* for legacy _lock_all() / _unlock_all() */
1576 struct mutex idr_mutex
; /* for IDR management */
1577 struct idr crtc_idr
; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
1578 struct idr tile_idr
; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
1579 /* this is limited to one for now */
1581 struct mutex fb_lock
; /* proctects global and per-file fb lists */
1583 struct list_head fb_list
;
1586 struct list_head connector_list
;
1588 struct list_head encoder_list
;
1591 * Track # of overlay planes separately from # of total planes. By
1592 * default we only advertise overlay planes to userspace; if userspace
1593 * sets the "universal plane" capability bit, we'll go ahead and
1594 * expose all planes.
1596 int num_overlay_plane
;
1597 int num_total_plane
;
1598 struct list_head plane_list
;
1601 struct list_head crtc_list
;
1603 struct list_head property_list
;
1605 int min_width
, min_height
;
1606 int max_width
, max_height
;
1607 const struct drm_mode_config_funcs
*funcs
;
1608 resource_size_t fb_base
;
1610 /* output poll support */
1614 struct delayed_work output_poll_work
;
1616 struct mutex blob_lock
;
1618 /* pointers to standard properties */
1619 struct list_head property_blob_list
;
1620 struct drm_property
*edid_property
;
1621 struct drm_property
*dpms_property
;
1622 struct drm_property
*path_property
;
1623 struct drm_property
*tile_property
;
1624 struct drm_property
*plane_type_property
;
1625 struct drm_property
*rotation_property
;
1626 struct drm_property
*prop_src_x
;
1627 struct drm_property
*prop_src_y
;
1628 struct drm_property
*prop_src_w
;
1629 struct drm_property
*prop_src_h
;
1630 struct drm_property
*prop_crtc_x
;
1631 struct drm_property
*prop_crtc_y
;
1632 struct drm_property
*prop_crtc_w
;
1633 struct drm_property
*prop_crtc_h
;
1634 struct drm_property
*prop_fb_id
;
1635 struct drm_property
*prop_crtc_id
;
1636 struct drm_property
*prop_active
;
1637 struct drm_property
*prop_mode_id
;
1639 /* DVI-I properties */
1640 struct drm_property
*dvi_i_subconnector_property
;
1641 struct drm_property
*dvi_i_select_subconnector_property
;
1644 struct drm_property
*tv_subconnector_property
;
1645 struct drm_property
*tv_select_subconnector_property
;
1646 struct drm_property
*tv_mode_property
;
1647 struct drm_property
*tv_left_margin_property
;
1648 struct drm_property
*tv_right_margin_property
;
1649 struct drm_property
*tv_top_margin_property
;
1650 struct drm_property
*tv_bottom_margin_property
;
1651 struct drm_property
*tv_brightness_property
;
1652 struct drm_property
*tv_contrast_property
;
1653 struct drm_property
*tv_flicker_reduction_property
;
1654 struct drm_property
*tv_overscan_property
;
1655 struct drm_property
*tv_saturation_property
;
1656 struct drm_property
*tv_hue_property
;
1658 /* Optional properties */
1659 struct drm_property
*scaling_mode_property
;
1660 struct drm_property
*aspect_ratio_property
;
1661 struct drm_property
*dirty_info_property
;
1663 /* properties for virtual machine layout */
1664 struct drm_property
*suggested_x_property
;
1665 struct drm_property
*suggested_y_property
;
1667 /* dumb ioctl parameters */
1668 uint32_t preferred_depth
, prefer_shadow
;
1670 /* whether async page flip is supported or not */
1671 bool async_page_flip
;
1673 /* whether the driver supports fb modifiers */
1674 bool allow_fb_modifiers
;
1677 uint32_t cursor_width
, cursor_height
;
1681 * drm_for_each_plane_mask - iterate over planes specified by bitmask
1682 * @plane: the loop cursor
1683 * @dev: the DRM device
1684 * @plane_mask: bitmask of plane indices
1686 * Iterate over all planes specified by bitmask.
1688 #define drm_for_each_plane_mask(plane, dev, plane_mask) \
1689 list_for_each_entry((plane), &(dev)->mode_config.plane_list, head) \
1690 for_each_if ((plane_mask) & (1 << drm_plane_index(plane)))
1693 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
1694 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
1695 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
1696 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
1697 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
1698 #define obj_to_property(x) container_of(x, struct drm_property, base)
1699 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
1700 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
1702 struct drm_prop_enum_list
{
1707 extern int drm_crtc_init_with_planes(struct drm_device
*dev
,
1708 struct drm_crtc
*crtc
,
1709 struct drm_plane
*primary
,
1710 struct drm_plane
*cursor
,
1711 const struct drm_crtc_funcs
*funcs
);
1712 extern void drm_crtc_cleanup(struct drm_crtc
*crtc
);
1713 extern unsigned int drm_crtc_index(struct drm_crtc
*crtc
);
1716 * drm_crtc_mask - find the mask of a registered CRTC
1717 * @crtc: CRTC to find mask for
1719 * Given a registered CRTC, return the mask bit of that CRTC for an
1720 * encoder's possible_crtcs field.
1722 static inline uint32_t drm_crtc_mask(struct drm_crtc
*crtc
)
1724 return 1 << drm_crtc_index(crtc
);
1727 extern void drm_connector_ida_init(void);
1728 extern void drm_connector_ida_destroy(void);
1729 extern int drm_connector_init(struct drm_device
*dev
,
1730 struct drm_connector
*connector
,
1731 const struct drm_connector_funcs
*funcs
,
1732 int connector_type
);
1733 int drm_connector_register(struct drm_connector
*connector
);
1734 void drm_connector_unregister(struct drm_connector
*connector
);
1736 extern void drm_connector_cleanup(struct drm_connector
*connector
);
1737 extern unsigned int drm_connector_index(struct drm_connector
*connector
);
1738 /* helper to unplug all connectors from sysfs for device */
1739 extern void drm_connector_unplug_all(struct drm_device
*dev
);
1741 extern int drm_bridge_add(struct drm_bridge
*bridge
);
1742 extern void drm_bridge_remove(struct drm_bridge
*bridge
);
1743 extern struct drm_bridge
*of_drm_find_bridge(struct device_node
*np
);
1744 extern int drm_bridge_attach(struct drm_device
*dev
, struct drm_bridge
*bridge
);
1746 bool drm_bridge_mode_fixup(struct drm_bridge
*bridge
,
1747 const struct drm_display_mode
*mode
,
1748 struct drm_display_mode
*adjusted_mode
);
1749 void drm_bridge_disable(struct drm_bridge
*bridge
);
1750 void drm_bridge_post_disable(struct drm_bridge
*bridge
);
1751 void drm_bridge_mode_set(struct drm_bridge
*bridge
,
1752 struct drm_display_mode
*mode
,
1753 struct drm_display_mode
*adjusted_mode
);
1754 void drm_bridge_pre_enable(struct drm_bridge
*bridge
);
1755 void drm_bridge_enable(struct drm_bridge
*bridge
);
1757 extern int drm_encoder_init(struct drm_device
*dev
,
1758 struct drm_encoder
*encoder
,
1759 const struct drm_encoder_funcs
*funcs
,
1763 * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
1764 * @encoder: encoder to test
1765 * @crtc: crtc to test
1767 * Return false if @encoder can't be driven by @crtc, true otherwise.
1769 static inline bool drm_encoder_crtc_ok(struct drm_encoder
*encoder
,
1770 struct drm_crtc
*crtc
)
1772 return !!(encoder
->possible_crtcs
& drm_crtc_mask(crtc
));
1775 extern int drm_universal_plane_init(struct drm_device
*dev
,
1776 struct drm_plane
*plane
,
1777 unsigned long possible_crtcs
,
1778 const struct drm_plane_funcs
*funcs
,
1779 const uint32_t *formats
,
1780 unsigned int format_count
,
1781 enum drm_plane_type type
);
1782 extern int drm_plane_init(struct drm_device
*dev
,
1783 struct drm_plane
*plane
,
1784 unsigned long possible_crtcs
,
1785 const struct drm_plane_funcs
*funcs
,
1786 const uint32_t *formats
, unsigned int format_count
,
1788 extern void drm_plane_cleanup(struct drm_plane
*plane
);
1789 extern unsigned int drm_plane_index(struct drm_plane
*plane
);
1790 extern struct drm_plane
* drm_plane_from_index(struct drm_device
*dev
, int idx
);
1791 extern void drm_plane_force_disable(struct drm_plane
*plane
);
1792 extern int drm_plane_check_pixel_format(const struct drm_plane
*plane
,
1794 extern void drm_crtc_get_hv_timing(const struct drm_display_mode
*mode
,
1795 int *hdisplay
, int *vdisplay
);
1796 extern int drm_crtc_check_viewport(const struct drm_crtc
*crtc
,
1798 const struct drm_display_mode
*mode
,
1799 const struct drm_framebuffer
*fb
);
1801 extern void drm_encoder_cleanup(struct drm_encoder
*encoder
);
1803 extern const char *drm_get_connector_status_name(enum drm_connector_status status
);
1804 extern const char *drm_get_subpixel_order_name(enum subpixel_order order
);
1805 extern const char *drm_get_dpms_name(int val
);
1806 extern const char *drm_get_dvi_i_subconnector_name(int val
);
1807 extern const char *drm_get_dvi_i_select_name(int val
);
1808 extern const char *drm_get_tv_subconnector_name(int val
);
1809 extern const char *drm_get_tv_select_name(int val
);
1810 extern void drm_fb_release(struct drm_file
*file_priv
);
1811 extern void drm_property_destroy_user_blobs(struct drm_device
*dev
,
1812 struct drm_file
*file_priv
);
1813 extern bool drm_probe_ddc(struct i2c_adapter
*adapter
);
1814 extern struct edid
*drm_get_edid(struct drm_connector
*connector
,
1815 struct i2c_adapter
*adapter
);
1816 extern struct edid
*drm_edid_duplicate(const struct edid
*edid
);
1817 extern int drm_add_edid_modes(struct drm_connector
*connector
, struct edid
*edid
);
1818 extern void drm_mode_config_init(struct drm_device
*dev
);
1819 extern void drm_mode_config_reset(struct drm_device
*dev
);
1820 extern void drm_mode_config_cleanup(struct drm_device
*dev
);
1822 extern int drm_mode_connector_set_path_property(struct drm_connector
*connector
,
1824 int drm_mode_connector_set_tile_property(struct drm_connector
*connector
);
1825 extern int drm_mode_connector_update_edid_property(struct drm_connector
*connector
,
1826 const struct edid
*edid
);
1828 extern int drm_display_info_set_bus_formats(struct drm_display_info
*info
,
1830 unsigned int num_formats
);
1832 static inline bool drm_property_type_is(struct drm_property
*property
,
1835 /* instanceof for props.. handles extended type vs original types: */
1836 if (property
->flags
& DRM_MODE_PROP_EXTENDED_TYPE
)
1837 return (property
->flags
& DRM_MODE_PROP_EXTENDED_TYPE
) == type
;
1838 return property
->flags
& type
;
1841 static inline bool drm_property_type_valid(struct drm_property
*property
)
1843 if (property
->flags
& DRM_MODE_PROP_EXTENDED_TYPE
)
1844 return !(property
->flags
& DRM_MODE_PROP_LEGACY_TYPE
);
1845 return !!(property
->flags
& DRM_MODE_PROP_LEGACY_TYPE
);
1848 extern int drm_object_property_set_value(struct drm_mode_object
*obj
,
1849 struct drm_property
*property
,
1851 extern int drm_object_property_get_value(struct drm_mode_object
*obj
,
1852 struct drm_property
*property
,
1854 extern int drm_framebuffer_init(struct drm_device
*dev
,
1855 struct drm_framebuffer
*fb
,
1856 const struct drm_framebuffer_funcs
*funcs
);
1857 extern struct drm_framebuffer
*drm_framebuffer_lookup(struct drm_device
*dev
,
1859 extern void drm_framebuffer_unreference(struct drm_framebuffer
*fb
);
1860 extern void drm_framebuffer_reference(struct drm_framebuffer
*fb
);
1861 extern void drm_framebuffer_remove(struct drm_framebuffer
*fb
);
1862 extern void drm_framebuffer_cleanup(struct drm_framebuffer
*fb
);
1863 extern void drm_framebuffer_unregister_private(struct drm_framebuffer
*fb
);
1865 extern void drm_object_attach_property(struct drm_mode_object
*obj
,
1866 struct drm_property
*property
,
1868 extern struct drm_property
*drm_property_create(struct drm_device
*dev
, int flags
,
1869 const char *name
, int num_values
);
1870 extern struct drm_property
*drm_property_create_enum(struct drm_device
*dev
, int flags
,
1872 const struct drm_prop_enum_list
*props
,
1874 struct drm_property
*drm_property_create_bitmask(struct drm_device
*dev
,
1875 int flags
, const char *name
,
1876 const struct drm_prop_enum_list
*props
,
1878 uint64_t supported_bits
);
1879 struct drm_property
*drm_property_create_range(struct drm_device
*dev
, int flags
,
1881 uint64_t min
, uint64_t max
);
1882 struct drm_property
*drm_property_create_signed_range(struct drm_device
*dev
,
1883 int flags
, const char *name
,
1884 int64_t min
, int64_t max
);
1885 struct drm_property
*drm_property_create_object(struct drm_device
*dev
,
1886 int flags
, const char *name
, uint32_t type
);
1887 struct drm_property
*drm_property_create_bool(struct drm_device
*dev
, int flags
,
1889 struct drm_property_blob
*drm_property_create_blob(struct drm_device
*dev
,
1892 struct drm_property_blob
*drm_property_lookup_blob(struct drm_device
*dev
,
1894 struct drm_property_blob
*drm_property_reference_blob(struct drm_property_blob
*blob
);
1895 void drm_property_unreference_blob(struct drm_property_blob
*blob
);
1896 extern void drm_property_destroy(struct drm_device
*dev
, struct drm_property
*property
);
1897 extern int drm_property_add_enum(struct drm_property
*property
, int index
,
1898 uint64_t value
, const char *name
);
1899 extern int drm_mode_create_dvi_i_properties(struct drm_device
*dev
);
1900 extern int drm_mode_create_tv_properties(struct drm_device
*dev
,
1901 unsigned int num_modes
,
1902 const char * const modes
[]);
1903 extern int drm_mode_create_scaling_mode_property(struct drm_device
*dev
);
1904 extern int drm_mode_create_aspect_ratio_property(struct drm_device
*dev
);
1905 extern int drm_mode_create_dirty_info_property(struct drm_device
*dev
);
1906 extern int drm_mode_create_suggested_offset_properties(struct drm_device
*dev
);
1907 extern bool drm_property_change_valid_get(struct drm_property
*property
,
1908 uint64_t value
, struct drm_mode_object
**ref
);
1909 extern void drm_property_change_valid_put(struct drm_property
*property
,
1910 struct drm_mode_object
*ref
);
1912 extern int drm_mode_connector_attach_encoder(struct drm_connector
*connector
,
1913 struct drm_encoder
*encoder
);
1914 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc
*crtc
,
1916 extern struct drm_mode_object
*drm_mode_object_find(struct drm_device
*dev
,
1917 uint32_t id
, uint32_t type
);
1920 extern int drm_mode_getresources(struct drm_device
*dev
,
1921 void *data
, struct drm_file
*file_priv
);
1922 extern int drm_mode_getplane_res(struct drm_device
*dev
, void *data
,
1923 struct drm_file
*file_priv
);
1924 extern int drm_mode_getcrtc(struct drm_device
*dev
,
1925 void *data
, struct drm_file
*file_priv
);
1926 extern int drm_mode_getconnector(struct drm_device
*dev
,
1927 void *data
, struct drm_file
*file_priv
);
1928 extern int drm_mode_set_config_internal(struct drm_mode_set
*set
);
1929 extern int drm_mode_setcrtc(struct drm_device
*dev
,
1930 void *data
, struct drm_file
*file_priv
);
1931 extern int drm_mode_getplane(struct drm_device
*dev
,
1932 void *data
, struct drm_file
*file_priv
);
1933 extern int drm_mode_setplane(struct drm_device
*dev
,
1934 void *data
, struct drm_file
*file_priv
);
1935 extern int drm_mode_cursor_ioctl(struct drm_device
*dev
,
1936 void *data
, struct drm_file
*file_priv
);
1937 extern int drm_mode_cursor2_ioctl(struct drm_device
*dev
,
1938 void *data
, struct drm_file
*file_priv
);
1939 extern int drm_mode_addfb(struct drm_device
*dev
,
1940 void *data
, struct drm_file
*file_priv
);
1941 extern int drm_mode_addfb2(struct drm_device
*dev
,
1942 void *data
, struct drm_file
*file_priv
);
1943 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp
, uint32_t depth
);
1944 extern int drm_mode_rmfb(struct drm_device
*dev
,
1945 void *data
, struct drm_file
*file_priv
);
1946 extern int drm_mode_getfb(struct drm_device
*dev
,
1947 void *data
, struct drm_file
*file_priv
);
1948 extern int drm_mode_dirtyfb_ioctl(struct drm_device
*dev
,
1949 void *data
, struct drm_file
*file_priv
);
1951 extern int drm_mode_getproperty_ioctl(struct drm_device
*dev
,
1952 void *data
, struct drm_file
*file_priv
);
1953 extern int drm_mode_getblob_ioctl(struct drm_device
*dev
,
1954 void *data
, struct drm_file
*file_priv
);
1955 extern int drm_mode_createblob_ioctl(struct drm_device
*dev
,
1956 void *data
, struct drm_file
*file_priv
);
1957 extern int drm_mode_destroyblob_ioctl(struct drm_device
*dev
,
1958 void *data
, struct drm_file
*file_priv
);
1959 extern int drm_mode_connector_property_set_ioctl(struct drm_device
*dev
,
1960 void *data
, struct drm_file
*file_priv
);
1961 extern int drm_mode_getencoder(struct drm_device
*dev
,
1962 void *data
, struct drm_file
*file_priv
);
1963 extern int drm_mode_gamma_get_ioctl(struct drm_device
*dev
,
1964 void *data
, struct drm_file
*file_priv
);
1965 extern int drm_mode_gamma_set_ioctl(struct drm_device
*dev
,
1966 void *data
, struct drm_file
*file_priv
);
1967 extern u8
drm_match_cea_mode(const struct drm_display_mode
*to_match
);
1968 extern enum hdmi_picture_aspect
drm_get_cea_aspect_ratio(const u8 video_code
);
1969 extern bool drm_detect_hdmi_monitor(struct edid
*edid
);
1970 extern bool drm_detect_monitor_audio(struct edid
*edid
);
1971 extern bool drm_rgb_quant_range_selectable(struct edid
*edid
);
1972 extern int drm_mode_page_flip_ioctl(struct drm_device
*dev
,
1973 void *data
, struct drm_file
*file_priv
);
1974 extern int drm_add_modes_noedid(struct drm_connector
*connector
,
1975 int hdisplay
, int vdisplay
);
1976 extern void drm_set_preferred_mode(struct drm_connector
*connector
,
1977 int hpref
, int vpref
);
1979 extern int drm_edid_header_is_valid(const u8
*raw_edid
);
1980 extern bool drm_edid_block_valid(u8
*raw_edid
, int block
, bool print_bad_edid
,
1981 bool *edid_corrupt
);
1982 extern bool drm_edid_is_valid(struct edid
*edid
);
1984 extern struct drm_tile_group
*drm_mode_create_tile_group(struct drm_device
*dev
,
1986 extern struct drm_tile_group
*drm_mode_get_tile_group(struct drm_device
*dev
,
1988 extern void drm_mode_put_tile_group(struct drm_device
*dev
,
1989 struct drm_tile_group
*tg
);
1990 struct drm_display_mode
*drm_mode_find_dmt(struct drm_device
*dev
,
1991 int hsize
, int vsize
, int fresh
,
1994 extern int drm_mode_create_dumb_ioctl(struct drm_device
*dev
,
1995 void *data
, struct drm_file
*file_priv
);
1996 extern int drm_mode_mmap_dumb_ioctl(struct drm_device
*dev
,
1997 void *data
, struct drm_file
*file_priv
);
1998 extern int drm_mode_destroy_dumb_ioctl(struct drm_device
*dev
,
1999 void *data
, struct drm_file
*file_priv
);
2000 extern int drm_mode_obj_get_properties_ioctl(struct drm_device
*dev
, void *data
,
2001 struct drm_file
*file_priv
);
2002 extern int drm_mode_obj_set_property_ioctl(struct drm_device
*dev
, void *data
,
2003 struct drm_file
*file_priv
);
2004 extern int drm_mode_plane_set_obj_prop(struct drm_plane
*plane
,
2005 struct drm_property
*property
,
2007 extern int drm_mode_atomic_ioctl(struct drm_device
*dev
,
2008 void *data
, struct drm_file
*file_priv
);
2010 extern void drm_fb_get_bpp_depth(uint32_t format
, unsigned int *depth
,
2012 extern int drm_format_num_planes(uint32_t format
);
2013 extern int drm_format_plane_cpp(uint32_t format
, int plane
);
2014 extern int drm_format_horz_chroma_subsampling(uint32_t format
);
2015 extern int drm_format_vert_chroma_subsampling(uint32_t format
);
2016 extern const char *drm_get_format_name(uint32_t format
);
2017 extern struct drm_property
*drm_mode_create_rotation_property(struct drm_device
*dev
,
2018 unsigned int supported_rotations
);
2019 extern unsigned int drm_rotation_simplify(unsigned int rotation
,
2020 unsigned int supported_rotations
);
2024 static inline struct drm_plane
*drm_plane_find(struct drm_device
*dev
,
2027 struct drm_mode_object
*mo
;
2028 mo
= drm_mode_object_find(dev
, id
, DRM_MODE_OBJECT_PLANE
);
2029 return mo
? obj_to_plane(mo
) : NULL
;
2032 static inline struct drm_crtc
*drm_crtc_find(struct drm_device
*dev
,
2035 struct drm_mode_object
*mo
;
2036 mo
= drm_mode_object_find(dev
, id
, DRM_MODE_OBJECT_CRTC
);
2037 return mo
? obj_to_crtc(mo
) : NULL
;
2040 static inline struct drm_encoder
*drm_encoder_find(struct drm_device
*dev
,
2043 struct drm_mode_object
*mo
;
2044 mo
= drm_mode_object_find(dev
, id
, DRM_MODE_OBJECT_ENCODER
);
2045 return mo
? obj_to_encoder(mo
) : NULL
;
2048 static inline struct drm_connector
*drm_connector_find(struct drm_device
*dev
,
2051 struct drm_mode_object
*mo
;
2052 mo
= drm_mode_object_find(dev
, id
, DRM_MODE_OBJECT_CONNECTOR
);
2053 return mo
? obj_to_connector(mo
) : NULL
;
2056 static inline struct drm_property
*drm_property_find(struct drm_device
*dev
,
2059 struct drm_mode_object
*mo
;
2060 mo
= drm_mode_object_find(dev
, id
, DRM_MODE_OBJECT_PROPERTY
);
2061 return mo
? obj_to_property(mo
) : NULL
;
2064 /* Plane list iterator for legacy (overlay only) planes. */
2065 #define drm_for_each_legacy_plane(plane, dev) \
2066 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) \
2067 for_each_if (plane->type == DRM_PLANE_TYPE_OVERLAY)
2069 #define drm_for_each_plane(plane, dev) \
2070 list_for_each_entry(plane, &(dev)->mode_config.plane_list, head)
2072 #define drm_for_each_crtc(crtc, dev) \
2073 list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)
2076 assert_drm_connector_list_read_locked(struct drm_mode_config
*mode_config
)
2079 * The connector hotadd/remove code currently grabs both locks when
2080 * updating lists. Hence readers need only hold either of them to be
2081 * safe and the check amounts to
2083 * WARN_ON(not_holding(A) && not_holding(B)).
2085 WARN_ON(!mutex_is_locked(&mode_config
->mutex
) &&
2086 !drm_modeset_is_locked(&mode_config
->connection_mutex
));
2089 #define drm_for_each_connector(connector, dev) \
2090 for (assert_drm_connector_list_read_locked(&(dev)->mode_config), \
2091 connector = list_first_entry(&(dev)->mode_config.connector_list, \
2092 struct drm_connector, head); \
2093 &connector->head != (&(dev)->mode_config.connector_list); \
2094 connector = list_next_entry(connector, head))
2096 #define drm_for_each_encoder(encoder, dev) \
2097 list_for_each_entry(encoder, &(dev)->mode_config.encoder_list, head)
2099 #define drm_for_each_fb(fb, dev) \
2100 for (WARN_ON(!mutex_is_locked(&(dev)->mode_config.fb_lock)), \
2101 fb = list_first_entry(&(dev)->mode_config.fb_list, \
2102 struct drm_framebuffer, head); \
2103 &fb->head != (&(dev)->mode_config.fb_list); \
2104 fb = list_next_entry(fb, head))
2106 #endif /* __DRM_CRTC_H__ */