2 * Copyright (c) 2016 Intel Corporation
4 * Permission to use, copy, modify, distribute, and sell this software and its
5 * documentation for any purpose is hereby granted without fee, provided that
6 * the above copyright notice appear in all copies and that both that copyright
7 * notice and this permission notice appear in supporting documentation, and
8 * that the name of the copyright holders not be used in advertising or
9 * publicity pertaining to distribution of the software without specific,
10 * written prior permission. The copyright holders make no representations
11 * about the suitability of this software for any purpose. It is provided "as
12 * is" without express or implied warranty.
14 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
24 #include <drm/drm_connector.h>
25 #include <drm/drm_edid.h>
26 #include <drm/drm_encoder.h>
28 #include "drm_crtc_internal.h"
29 #include "drm_internal.h"
34 * In DRM connectors are the general abstraction for display sinks, and include
35 * als fixed panels or anything else that can display pixels in some form. As
36 * opposed to all other KMS objects representing hardware (like CRTC, encoder or
37 * plane abstractions) connectors can be hotplugged and unplugged at runtime.
38 * Hence they are reference-counted using drm_connector_reference() and
39 * drm_connector_unreference().
41 * KMS driver must create, initialize, register and attach at a &struct
42 * drm_connector for each such sink. The instance is created as other KMS
43 * objects and initialized by setting the following fields. The connector is
44 * initialized with a call to drm_connector_init() with a pointer to the
45 * &struct drm_connector_funcs and a connector type, and then exposed to
46 * userspace with a call to drm_connector_register().
48 * Connectors must be attached to an encoder to be used. For devices that map
49 * connectors to encoders 1:1, the connector should be attached at
50 * initialization time with a call to drm_mode_connector_attach_encoder(). The
51 * driver must also set the &drm_connector.encoder field to point to the
54 * For connectors which are not fixed (like built-in panels) the driver needs to
55 * support hotplug notifications. The simplest way to do that is by using the
56 * probe helpers, see drm_kms_helper_poll_init() for connectors which don't have
57 * hardware support for hotplug interrupts. Connectors with hardware hotplug
58 * support can instead use e.g. drm_helper_hpd_irq_event().
61 struct drm_conn_prop_enum_list
{
68 * Connector and encoder types.
70 static struct drm_conn_prop_enum_list drm_connector_enum_list
[] = {
71 { DRM_MODE_CONNECTOR_Unknown
, "Unknown" },
72 { DRM_MODE_CONNECTOR_VGA
, "VGA" },
73 { DRM_MODE_CONNECTOR_DVII
, "DVI-I" },
74 { DRM_MODE_CONNECTOR_DVID
, "DVI-D" },
75 { DRM_MODE_CONNECTOR_DVIA
, "DVI-A" },
76 { DRM_MODE_CONNECTOR_Composite
, "Composite" },
77 { DRM_MODE_CONNECTOR_SVIDEO
, "SVIDEO" },
78 { DRM_MODE_CONNECTOR_LVDS
, "LVDS" },
79 { DRM_MODE_CONNECTOR_Component
, "Component" },
80 { DRM_MODE_CONNECTOR_9PinDIN
, "DIN" },
81 { DRM_MODE_CONNECTOR_DisplayPort
, "DP" },
82 { DRM_MODE_CONNECTOR_HDMIA
, "HDMI-A" },
83 { DRM_MODE_CONNECTOR_HDMIB
, "HDMI-B" },
84 { DRM_MODE_CONNECTOR_TV
, "TV" },
85 { DRM_MODE_CONNECTOR_eDP
, "eDP" },
86 { DRM_MODE_CONNECTOR_VIRTUAL
, "Virtual" },
87 { DRM_MODE_CONNECTOR_DSI
, "DSI" },
88 { DRM_MODE_CONNECTOR_DPI
, "DPI" },
91 void drm_connector_ida_init(void)
95 for (i
= 0; i
< ARRAY_SIZE(drm_connector_enum_list
); i
++)
96 ida_init(&drm_connector_enum_list
[i
].ida
);
99 void drm_connector_ida_destroy(void)
103 for (i
= 0; i
< ARRAY_SIZE(drm_connector_enum_list
); i
++)
104 ida_destroy(&drm_connector_enum_list
[i
].ida
);
108 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
109 * @connector: connector to quwery
111 * The kernel supports per-connector configuration of its consoles through
112 * use of the video= parameter. This function parses that option and
113 * extracts the user's specified mode (or enable/disable status) for a
114 * particular connector. This is typically only used during the early fbdev
117 static void drm_connector_get_cmdline_mode(struct drm_connector
*connector
)
119 struct drm_cmdline_mode
*mode
= &connector
->cmdline_mode
;
122 if (fb_get_options(connector
->name
, &option
))
125 if (!drm_mode_parse_command_line_for_connector(option
,
133 switch (mode
->force
) {
137 case DRM_FORCE_ON_DIGITAL
:
146 DRM_INFO("forcing %s connector %s\n", connector
->name
, s
);
147 connector
->force
= mode
->force
;
150 DRM_DEBUG_KMS("cmdline mode for connector %s %dx%d@%dHz%s%s%s\n",
152 mode
->xres
, mode
->yres
,
153 mode
->refresh_specified
? mode
->refresh
: 60,
154 mode
->rb
? " reduced blanking" : "",
155 mode
->margins
? " with margins" : "",
156 mode
->interlace
? " interlaced" : "");
159 static void drm_connector_free(struct kref
*kref
)
161 struct drm_connector
*connector
=
162 container_of(kref
, struct drm_connector
, base
.refcount
);
163 struct drm_device
*dev
= connector
->dev
;
165 drm_mode_object_unregister(dev
, &connector
->base
);
166 connector
->funcs
->destroy(connector
);
170 * drm_connector_init - Init a preallocated connector
172 * @connector: the connector to init
173 * @funcs: callbacks for this connector
174 * @connector_type: user visible type of the connector
176 * Initialises a preallocated connector. Connectors should be
177 * subclassed as part of driver connector objects.
180 * Zero on success, error code on failure.
182 int drm_connector_init(struct drm_device
*dev
,
183 struct drm_connector
*connector
,
184 const struct drm_connector_funcs
*funcs
,
187 struct drm_mode_config
*config
= &dev
->mode_config
;
189 struct ida
*connector_ida
=
190 &drm_connector_enum_list
[connector_type
].ida
;
192 ret
= drm_mode_object_get_reg(dev
, &connector
->base
,
193 DRM_MODE_OBJECT_CONNECTOR
,
194 false, drm_connector_free
);
198 connector
->base
.properties
= &connector
->properties
;
199 connector
->dev
= dev
;
200 connector
->funcs
= funcs
;
202 ret
= ida_simple_get(&config
->connector_ida
, 0, 0, GFP_KERNEL
);
205 connector
->index
= ret
;
208 connector
->connector_type
= connector_type
;
209 connector
->connector_type_id
=
210 ida_simple_get(connector_ida
, 1, 0, GFP_KERNEL
);
211 if (connector
->connector_type_id
< 0) {
212 ret
= connector
->connector_type_id
;
216 kasprintf(GFP_KERNEL
, "%s-%d",
217 drm_connector_enum_list
[connector_type
].name
,
218 connector
->connector_type_id
);
219 if (!connector
->name
) {
221 goto out_put_type_id
;
224 INIT_LIST_HEAD(&connector
->probed_modes
);
225 INIT_LIST_HEAD(&connector
->modes
);
226 mutex_init(&connector
->mutex
);
227 connector
->edid_blob_ptr
= NULL
;
228 connector
->status
= connector_status_unknown
;
230 drm_connector_get_cmdline_mode(connector
);
232 /* We should add connectors at the end to avoid upsetting the connector
234 spin_lock_irq(&config
->connector_list_lock
);
235 list_add_tail(&connector
->head
, &config
->connector_list
);
236 config
->num_connector
++;
237 spin_unlock_irq(&config
->connector_list_lock
);
239 if (connector_type
!= DRM_MODE_CONNECTOR_VIRTUAL
)
240 drm_object_attach_property(&connector
->base
,
241 config
->edid_property
,
244 drm_object_attach_property(&connector
->base
,
245 config
->dpms_property
, 0);
247 drm_object_attach_property(&connector
->base
,
248 config
->link_status_property
,
251 if (drm_core_check_feature(dev
, DRIVER_ATOMIC
)) {
252 drm_object_attach_property(&connector
->base
, config
->prop_crtc_id
, 0);
255 connector
->debugfs_entry
= NULL
;
258 ida_simple_remove(connector_ida
, connector
->connector_type_id
);
261 ida_simple_remove(&config
->connector_ida
, connector
->index
);
264 drm_mode_object_unregister(dev
, &connector
->base
);
268 EXPORT_SYMBOL(drm_connector_init
);
271 * drm_mode_connector_attach_encoder - attach a connector to an encoder
272 * @connector: connector to attach
273 * @encoder: encoder to attach @connector to
275 * This function links up a connector to an encoder. Note that the routing
276 * restrictions between encoders and crtcs are exposed to userspace through the
277 * possible_clones and possible_crtcs bitmasks.
280 * Zero on success, negative errno on failure.
282 int drm_mode_connector_attach_encoder(struct drm_connector
*connector
,
283 struct drm_encoder
*encoder
)
288 * In the past, drivers have attempted to model the static association
289 * of connector to encoder in simple connector/encoder devices using a
290 * direct assignment of connector->encoder = encoder. This connection
291 * is a logical one and the responsibility of the core, so drivers are
292 * expected not to mess with this.
294 * Note that the error return should've been enough here, but a large
295 * majority of drivers ignores the return value, so add in a big WARN
296 * to get people's attention.
298 if (WARN_ON(connector
->encoder
))
301 for (i
= 0; i
< DRM_CONNECTOR_MAX_ENCODER
; i
++) {
302 if (connector
->encoder_ids
[i
] == 0) {
303 connector
->encoder_ids
[i
] = encoder
->base
.id
;
309 EXPORT_SYMBOL(drm_mode_connector_attach_encoder
);
311 static void drm_mode_remove(struct drm_connector
*connector
,
312 struct drm_display_mode
*mode
)
314 list_del(&mode
->head
);
315 drm_mode_destroy(connector
->dev
, mode
);
319 * drm_connector_cleanup - cleans up an initialised connector
320 * @connector: connector to cleanup
322 * Cleans up the connector but doesn't free the object.
324 void drm_connector_cleanup(struct drm_connector
*connector
)
326 struct drm_device
*dev
= connector
->dev
;
327 struct drm_display_mode
*mode
, *t
;
329 /* The connector should have been removed from userspace long before
330 * it is finally destroyed.
332 if (WARN_ON(connector
->registered
))
333 drm_connector_unregister(connector
);
335 if (connector
->tile_group
) {
336 drm_mode_put_tile_group(dev
, connector
->tile_group
);
337 connector
->tile_group
= NULL
;
340 list_for_each_entry_safe(mode
, t
, &connector
->probed_modes
, head
)
341 drm_mode_remove(connector
, mode
);
343 list_for_each_entry_safe(mode
, t
, &connector
->modes
, head
)
344 drm_mode_remove(connector
, mode
);
346 ida_simple_remove(&drm_connector_enum_list
[connector
->connector_type
].ida
,
347 connector
->connector_type_id
);
349 ida_simple_remove(&dev
->mode_config
.connector_ida
,
352 kfree(connector
->display_info
.bus_formats
);
353 drm_mode_object_unregister(dev
, &connector
->base
);
354 kfree(connector
->name
);
355 connector
->name
= NULL
;
356 spin_lock_irq(&dev
->mode_config
.connector_list_lock
);
357 list_del(&connector
->head
);
358 dev
->mode_config
.num_connector
--;
359 spin_unlock_irq(&dev
->mode_config
.connector_list_lock
);
361 WARN_ON(connector
->state
&& !connector
->funcs
->atomic_destroy_state
);
362 if (connector
->state
&& connector
->funcs
->atomic_destroy_state
)
363 connector
->funcs
->atomic_destroy_state(connector
,
366 mutex_destroy(&connector
->mutex
);
368 memset(connector
, 0, sizeof(*connector
));
370 EXPORT_SYMBOL(drm_connector_cleanup
);
373 * drm_connector_register - register a connector
374 * @connector: the connector to register
376 * Register userspace interfaces for a connector
379 * Zero on success, error code on failure.
381 int drm_connector_register(struct drm_connector
*connector
)
385 if (!connector
->dev
->registered
)
388 mutex_lock(&connector
->mutex
);
389 if (connector
->registered
)
392 ret
= drm_sysfs_connector_add(connector
);
396 ret
= drm_debugfs_connector_add(connector
);
401 if (connector
->funcs
->late_register
) {
402 ret
= connector
->funcs
->late_register(connector
);
407 drm_mode_object_register(connector
->dev
, &connector
->base
);
409 connector
->registered
= true;
413 drm_debugfs_connector_remove(connector
);
415 drm_sysfs_connector_remove(connector
);
417 mutex_unlock(&connector
->mutex
);
420 EXPORT_SYMBOL(drm_connector_register
);
423 * drm_connector_unregister - unregister a connector
424 * @connector: the connector to unregister
426 * Unregister userspace interfaces for a connector
428 void drm_connector_unregister(struct drm_connector
*connector
)
430 mutex_lock(&connector
->mutex
);
431 if (!connector
->registered
) {
432 mutex_unlock(&connector
->mutex
);
436 if (connector
->funcs
->early_unregister
)
437 connector
->funcs
->early_unregister(connector
);
439 drm_sysfs_connector_remove(connector
);
440 drm_debugfs_connector_remove(connector
);
442 connector
->registered
= false;
443 mutex_unlock(&connector
->mutex
);
445 EXPORT_SYMBOL(drm_connector_unregister
);
447 void drm_connector_unregister_all(struct drm_device
*dev
)
449 struct drm_connector
*connector
;
450 struct drm_connector_list_iter conn_iter
;
452 drm_connector_list_iter_get(dev
, &conn_iter
);
453 drm_for_each_connector_iter(connector
, &conn_iter
)
454 drm_connector_unregister(connector
);
455 drm_connector_list_iter_put(&conn_iter
);
458 int drm_connector_register_all(struct drm_device
*dev
)
460 struct drm_connector
*connector
;
461 struct drm_connector_list_iter conn_iter
;
464 drm_connector_list_iter_get(dev
, &conn_iter
);
465 drm_for_each_connector_iter(connector
, &conn_iter
) {
466 ret
= drm_connector_register(connector
);
470 drm_connector_list_iter_put(&conn_iter
);
473 drm_connector_unregister_all(dev
);
478 * drm_get_connector_status_name - return a string for connector status
479 * @status: connector status to compute name of
481 * In contrast to the other drm_get_*_name functions this one here returns a
482 * const pointer and hence is threadsafe.
484 const char *drm_get_connector_status_name(enum drm_connector_status status
)
486 if (status
== connector_status_connected
)
488 else if (status
== connector_status_disconnected
)
489 return "disconnected";
493 EXPORT_SYMBOL(drm_get_connector_status_name
);
495 #ifdef CONFIG_LOCKDEP
496 static struct lockdep_map connector_list_iter_dep_map
= {
497 .name
= "drm_connector_list_iter"
502 * drm_connector_list_iter_get - initialize a connector_list iterator
504 * @iter: connector_list iterator
506 * Sets @iter up to walk the &drm_mode_config.connector_list of @dev. @iter
507 * must always be cleaned up again by calling drm_connector_list_iter_put().
508 * Iteration itself happens using drm_connector_list_iter_next() or
509 * drm_for_each_connector_iter().
511 void drm_connector_list_iter_get(struct drm_device
*dev
,
512 struct drm_connector_list_iter
*iter
)
516 lock_acquire_shared_recursive(&connector_list_iter_dep_map
, 0, 1, NULL
, _RET_IP_
);
518 EXPORT_SYMBOL(drm_connector_list_iter_get
);
521 * drm_connector_list_iter_next - return next connector
522 * @iter: connectr_list iterator
524 * Returns the next connector for @iter, or NULL when the list walk has
527 struct drm_connector
*
528 drm_connector_list_iter_next(struct drm_connector_list_iter
*iter
)
530 struct drm_connector
*old_conn
= iter
->conn
;
531 struct drm_mode_config
*config
= &iter
->dev
->mode_config
;
532 struct list_head
*lhead
;
535 spin_lock_irqsave(&config
->connector_list_lock
, flags
);
536 lhead
= old_conn
? &old_conn
->head
: &config
->connector_list
;
539 if (lhead
->next
== &config
->connector_list
) {
545 iter
->conn
= list_entry(lhead
, struct drm_connector
, head
);
547 /* loop until it's not a zombie connector */
548 } while (!kref_get_unless_zero(&iter
->conn
->base
.refcount
));
549 spin_unlock_irqrestore(&config
->connector_list_lock
, flags
);
552 drm_connector_unreference(old_conn
);
556 EXPORT_SYMBOL(drm_connector_list_iter_next
);
559 * drm_connector_list_iter_put - tear down a connector_list iterator
560 * @iter: connector_list iterator
562 * Tears down @iter and releases any resources (like &drm_connector references)
563 * acquired while walking the list. This must always be called, both when the
564 * iteration completes fully or when it was aborted without walking the entire
567 void drm_connector_list_iter_put(struct drm_connector_list_iter
*iter
)
571 drm_connector_unreference(iter
->conn
);
572 lock_release(&connector_list_iter_dep_map
, 0, _RET_IP_
);
574 EXPORT_SYMBOL(drm_connector_list_iter_put
);
576 static const struct drm_prop_enum_list drm_subpixel_enum_list
[] = {
577 { SubPixelUnknown
, "Unknown" },
578 { SubPixelHorizontalRGB
, "Horizontal RGB" },
579 { SubPixelHorizontalBGR
, "Horizontal BGR" },
580 { SubPixelVerticalRGB
, "Vertical RGB" },
581 { SubPixelVerticalBGR
, "Vertical BGR" },
582 { SubPixelNone
, "None" },
586 * drm_get_subpixel_order_name - return a string for a given subpixel enum
587 * @order: enum of subpixel_order
589 * Note you could abuse this and return something out of bounds, but that
590 * would be a caller error. No unscrubbed user data should make it here.
592 const char *drm_get_subpixel_order_name(enum subpixel_order order
)
594 return drm_subpixel_enum_list
[order
].name
;
596 EXPORT_SYMBOL(drm_get_subpixel_order_name
);
598 static const struct drm_prop_enum_list drm_dpms_enum_list
[] = {
599 { DRM_MODE_DPMS_ON
, "On" },
600 { DRM_MODE_DPMS_STANDBY
, "Standby" },
601 { DRM_MODE_DPMS_SUSPEND
, "Suspend" },
602 { DRM_MODE_DPMS_OFF
, "Off" }
604 DRM_ENUM_NAME_FN(drm_get_dpms_name
, drm_dpms_enum_list
)
606 static const struct drm_prop_enum_list drm_link_status_enum_list
[] = {
607 { DRM_MODE_LINK_STATUS_GOOD
, "Good" },
608 { DRM_MODE_LINK_STATUS_BAD
, "Bad" },
610 DRM_ENUM_NAME_FN(drm_get_link_status_name
, drm_link_status_enum_list
)
613 * drm_display_info_set_bus_formats - set the supported bus formats
614 * @info: display info to store bus formats in
615 * @formats: array containing the supported bus formats
616 * @num_formats: the number of entries in the fmts array
618 * Store the supported bus formats in display info structure.
619 * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
620 * a full list of available formats.
622 int drm_display_info_set_bus_formats(struct drm_display_info
*info
,
624 unsigned int num_formats
)
628 if (!formats
&& num_formats
)
631 if (formats
&& num_formats
) {
632 fmts
= kmemdup(formats
, sizeof(*formats
) * num_formats
,
638 kfree(info
->bus_formats
);
639 info
->bus_formats
= fmts
;
640 info
->num_bus_formats
= num_formats
;
644 EXPORT_SYMBOL(drm_display_info_set_bus_formats
);
646 /* Optional connector properties. */
647 static const struct drm_prop_enum_list drm_scaling_mode_enum_list
[] = {
648 { DRM_MODE_SCALE_NONE
, "None" },
649 { DRM_MODE_SCALE_FULLSCREEN
, "Full" },
650 { DRM_MODE_SCALE_CENTER
, "Center" },
651 { DRM_MODE_SCALE_ASPECT
, "Full aspect" },
654 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list
[] = {
655 { DRM_MODE_PICTURE_ASPECT_NONE
, "Automatic" },
656 { DRM_MODE_PICTURE_ASPECT_4_3
, "4:3" },
657 { DRM_MODE_PICTURE_ASPECT_16_9
, "16:9" },
660 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list
[] = {
661 { DRM_MODE_SUBCONNECTOR_Automatic
, "Automatic" }, /* DVI-I and TV-out */
662 { DRM_MODE_SUBCONNECTOR_DVID
, "DVI-D" }, /* DVI-I */
663 { DRM_MODE_SUBCONNECTOR_DVIA
, "DVI-A" }, /* DVI-I */
665 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name
, drm_dvi_i_select_enum_list
)
667 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list
[] = {
668 { DRM_MODE_SUBCONNECTOR_Unknown
, "Unknown" }, /* DVI-I and TV-out */
669 { DRM_MODE_SUBCONNECTOR_DVID
, "DVI-D" }, /* DVI-I */
670 { DRM_MODE_SUBCONNECTOR_DVIA
, "DVI-A" }, /* DVI-I */
672 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name
,
673 drm_dvi_i_subconnector_enum_list
)
675 static const struct drm_prop_enum_list drm_tv_select_enum_list
[] = {
676 { DRM_MODE_SUBCONNECTOR_Automatic
, "Automatic" }, /* DVI-I and TV-out */
677 { DRM_MODE_SUBCONNECTOR_Composite
, "Composite" }, /* TV-out */
678 { DRM_MODE_SUBCONNECTOR_SVIDEO
, "SVIDEO" }, /* TV-out */
679 { DRM_MODE_SUBCONNECTOR_Component
, "Component" }, /* TV-out */
680 { DRM_MODE_SUBCONNECTOR_SCART
, "SCART" }, /* TV-out */
682 DRM_ENUM_NAME_FN(drm_get_tv_select_name
, drm_tv_select_enum_list
)
684 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list
[] = {
685 { DRM_MODE_SUBCONNECTOR_Unknown
, "Unknown" }, /* DVI-I and TV-out */
686 { DRM_MODE_SUBCONNECTOR_Composite
, "Composite" }, /* TV-out */
687 { DRM_MODE_SUBCONNECTOR_SVIDEO
, "SVIDEO" }, /* TV-out */
688 { DRM_MODE_SUBCONNECTOR_Component
, "Component" }, /* TV-out */
689 { DRM_MODE_SUBCONNECTOR_SCART
, "SCART" }, /* TV-out */
691 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name
,
692 drm_tv_subconnector_enum_list
)
695 * DOC: standard connector properties
697 * DRM connectors have a few standardized properties:
700 * Blob property which contains the current EDID read from the sink. This
701 * is useful to parse sink identification information like vendor, model
702 * and serial. Drivers should update this property by calling
703 * drm_mode_connector_update_edid_property(), usually after having parsed
704 * the EDID using drm_add_edid_modes(). Userspace cannot change this
707 * Legacy property for setting the power state of the connector. For atomic
708 * drivers this is only provided for backwards compatibility with existing
709 * drivers, it remaps to controlling the "ACTIVE" property on the CRTC the
710 * connector is linked to. Drivers should never set this property directly,
711 * it is handled by the DRM core by calling the &drm_connector_funcs.dpms
712 * callback. Atomic drivers should implement this hook using
713 * drm_atomic_helper_connector_dpms(). This is the only property standard
714 * connector property that userspace can change.
716 * Connector path property to identify how this sink is physically
717 * connected. Used by DP MST. This should be set by calling
718 * drm_mode_connector_set_path_property(), in the case of DP MST with the
719 * path property the MST manager created. Userspace cannot change this
722 * Connector tile group property to indicate how a set of DRM connector
723 * compose together into one logical screen. This is used by both high-res
724 * external screens (often only using a single cable, but exposing multiple
725 * DP MST sinks), or high-res integrated panels (like dual-link DSI) which
726 * are not gen-locked. Note that for tiled panels which are genlocked, like
727 * dual-link LVDS or dual-link DSI, the driver should try to not expose the
728 * tiling and virtualize both &drm_crtc and &drm_plane if needed. Drivers
729 * should update this value using drm_mode_connector_set_tile_property().
730 * Userspace cannot change this property.
732 * Connector link-status property to indicate the status of link. The default
733 * value of link-status is "GOOD". If something fails during or after modeset,
734 * the kernel driver may set this to "BAD" and issue a hotplug uevent. Drivers
735 * should update this value using drm_mode_connector_set_link_status_property().
737 * Connectors also have one standardized atomic property:
740 * Mode object ID of the &drm_crtc this connector should be connected to.
743 int drm_connector_create_standard_properties(struct drm_device
*dev
)
745 struct drm_property
*prop
;
747 prop
= drm_property_create(dev
, DRM_MODE_PROP_BLOB
|
748 DRM_MODE_PROP_IMMUTABLE
,
752 dev
->mode_config
.edid_property
= prop
;
754 prop
= drm_property_create_enum(dev
, 0,
755 "DPMS", drm_dpms_enum_list
,
756 ARRAY_SIZE(drm_dpms_enum_list
));
759 dev
->mode_config
.dpms_property
= prop
;
761 prop
= drm_property_create(dev
,
763 DRM_MODE_PROP_IMMUTABLE
,
767 dev
->mode_config
.path_property
= prop
;
769 prop
= drm_property_create(dev
,
771 DRM_MODE_PROP_IMMUTABLE
,
775 dev
->mode_config
.tile_property
= prop
;
777 prop
= drm_property_create_enum(dev
, 0, "link-status",
778 drm_link_status_enum_list
,
779 ARRAY_SIZE(drm_link_status_enum_list
));
782 dev
->mode_config
.link_status_property
= prop
;
788 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
791 * Called by a driver the first time a DVI-I connector is made.
793 int drm_mode_create_dvi_i_properties(struct drm_device
*dev
)
795 struct drm_property
*dvi_i_selector
;
796 struct drm_property
*dvi_i_subconnector
;
798 if (dev
->mode_config
.dvi_i_select_subconnector_property
)
802 drm_property_create_enum(dev
, 0,
803 "select subconnector",
804 drm_dvi_i_select_enum_list
,
805 ARRAY_SIZE(drm_dvi_i_select_enum_list
));
806 dev
->mode_config
.dvi_i_select_subconnector_property
= dvi_i_selector
;
808 dvi_i_subconnector
= drm_property_create_enum(dev
, DRM_MODE_PROP_IMMUTABLE
,
810 drm_dvi_i_subconnector_enum_list
,
811 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list
));
812 dev
->mode_config
.dvi_i_subconnector_property
= dvi_i_subconnector
;
816 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties
);
819 * drm_create_tv_properties - create TV specific connector properties
821 * @num_modes: number of different TV formats (modes) supported
822 * @modes: array of pointers to strings containing name of each format
824 * Called by a driver's TV initialization routine, this function creates
825 * the TV specific connector properties for a given device. Caller is
826 * responsible for allocating a list of format names and passing them to
829 int drm_mode_create_tv_properties(struct drm_device
*dev
,
830 unsigned int num_modes
,
831 const char * const modes
[])
833 struct drm_property
*tv_selector
;
834 struct drm_property
*tv_subconnector
;
837 if (dev
->mode_config
.tv_select_subconnector_property
)
841 * Basic connector properties
843 tv_selector
= drm_property_create_enum(dev
, 0,
844 "select subconnector",
845 drm_tv_select_enum_list
,
846 ARRAY_SIZE(drm_tv_select_enum_list
));
850 dev
->mode_config
.tv_select_subconnector_property
= tv_selector
;
853 drm_property_create_enum(dev
, DRM_MODE_PROP_IMMUTABLE
,
855 drm_tv_subconnector_enum_list
,
856 ARRAY_SIZE(drm_tv_subconnector_enum_list
));
857 if (!tv_subconnector
)
859 dev
->mode_config
.tv_subconnector_property
= tv_subconnector
;
862 * Other, TV specific properties: margins & TV modes.
864 dev
->mode_config
.tv_left_margin_property
=
865 drm_property_create_range(dev
, 0, "left margin", 0, 100);
866 if (!dev
->mode_config
.tv_left_margin_property
)
869 dev
->mode_config
.tv_right_margin_property
=
870 drm_property_create_range(dev
, 0, "right margin", 0, 100);
871 if (!dev
->mode_config
.tv_right_margin_property
)
874 dev
->mode_config
.tv_top_margin_property
=
875 drm_property_create_range(dev
, 0, "top margin", 0, 100);
876 if (!dev
->mode_config
.tv_top_margin_property
)
879 dev
->mode_config
.tv_bottom_margin_property
=
880 drm_property_create_range(dev
, 0, "bottom margin", 0, 100);
881 if (!dev
->mode_config
.tv_bottom_margin_property
)
884 dev
->mode_config
.tv_mode_property
=
885 drm_property_create(dev
, DRM_MODE_PROP_ENUM
,
887 if (!dev
->mode_config
.tv_mode_property
)
890 for (i
= 0; i
< num_modes
; i
++)
891 drm_property_add_enum(dev
->mode_config
.tv_mode_property
, i
,
894 dev
->mode_config
.tv_brightness_property
=
895 drm_property_create_range(dev
, 0, "brightness", 0, 100);
896 if (!dev
->mode_config
.tv_brightness_property
)
899 dev
->mode_config
.tv_contrast_property
=
900 drm_property_create_range(dev
, 0, "contrast", 0, 100);
901 if (!dev
->mode_config
.tv_contrast_property
)
904 dev
->mode_config
.tv_flicker_reduction_property
=
905 drm_property_create_range(dev
, 0, "flicker reduction", 0, 100);
906 if (!dev
->mode_config
.tv_flicker_reduction_property
)
909 dev
->mode_config
.tv_overscan_property
=
910 drm_property_create_range(dev
, 0, "overscan", 0, 100);
911 if (!dev
->mode_config
.tv_overscan_property
)
914 dev
->mode_config
.tv_saturation_property
=
915 drm_property_create_range(dev
, 0, "saturation", 0, 100);
916 if (!dev
->mode_config
.tv_saturation_property
)
919 dev
->mode_config
.tv_hue_property
=
920 drm_property_create_range(dev
, 0, "hue", 0, 100);
921 if (!dev
->mode_config
.tv_hue_property
)
928 EXPORT_SYMBOL(drm_mode_create_tv_properties
);
931 * drm_mode_create_scaling_mode_property - create scaling mode property
934 * Called by a driver the first time it's needed, must be attached to desired
937 int drm_mode_create_scaling_mode_property(struct drm_device
*dev
)
939 struct drm_property
*scaling_mode
;
941 if (dev
->mode_config
.scaling_mode_property
)
945 drm_property_create_enum(dev
, 0, "scaling mode",
946 drm_scaling_mode_enum_list
,
947 ARRAY_SIZE(drm_scaling_mode_enum_list
));
949 dev
->mode_config
.scaling_mode_property
= scaling_mode
;
953 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property
);
956 * drm_mode_create_aspect_ratio_property - create aspect ratio property
959 * Called by a driver the first time it's needed, must be attached to desired
963 * Zero on success, negative errno on failure.
965 int drm_mode_create_aspect_ratio_property(struct drm_device
*dev
)
967 if (dev
->mode_config
.aspect_ratio_property
)
970 dev
->mode_config
.aspect_ratio_property
=
971 drm_property_create_enum(dev
, 0, "aspect ratio",
972 drm_aspect_ratio_enum_list
,
973 ARRAY_SIZE(drm_aspect_ratio_enum_list
));
975 if (dev
->mode_config
.aspect_ratio_property
== NULL
)
980 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property
);
983 * drm_mode_create_suggested_offset_properties - create suggests offset properties
986 * Create the the suggested x/y offset property for connectors.
988 int drm_mode_create_suggested_offset_properties(struct drm_device
*dev
)
990 if (dev
->mode_config
.suggested_x_property
&& dev
->mode_config
.suggested_y_property
)
993 dev
->mode_config
.suggested_x_property
=
994 drm_property_create_range(dev
, DRM_MODE_PROP_IMMUTABLE
, "suggested X", 0, 0xffffffff);
996 dev
->mode_config
.suggested_y_property
=
997 drm_property_create_range(dev
, DRM_MODE_PROP_IMMUTABLE
, "suggested Y", 0, 0xffffffff);
999 if (dev
->mode_config
.suggested_x_property
== NULL
||
1000 dev
->mode_config
.suggested_y_property
== NULL
)
1004 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties
);
1007 * drm_mode_connector_set_path_property - set tile property on connector
1008 * @connector: connector to set property on.
1009 * @path: path to use for property; must not be NULL.
1011 * This creates a property to expose to userspace to specify a
1012 * connector path. This is mainly used for DisplayPort MST where
1013 * connectors have a topology and we want to allow userspace to give
1014 * them more meaningful names.
1017 * Zero on success, negative errno on failure.
1019 int drm_mode_connector_set_path_property(struct drm_connector
*connector
,
1022 struct drm_device
*dev
= connector
->dev
;
1025 ret
= drm_property_replace_global_blob(dev
,
1026 &connector
->path_blob_ptr
,
1030 dev
->mode_config
.path_property
);
1033 EXPORT_SYMBOL(drm_mode_connector_set_path_property
);
1036 * drm_mode_connector_set_tile_property - set tile property on connector
1037 * @connector: connector to set property on.
1039 * This looks up the tile information for a connector, and creates a
1040 * property for userspace to parse if it exists. The property is of
1041 * the form of 8 integers using ':' as a separator.
1044 * Zero on success, errno on failure.
1046 int drm_mode_connector_set_tile_property(struct drm_connector
*connector
)
1048 struct drm_device
*dev
= connector
->dev
;
1052 if (!connector
->has_tile
) {
1053 ret
= drm_property_replace_global_blob(dev
,
1054 &connector
->tile_blob_ptr
,
1058 dev
->mode_config
.tile_property
);
1062 snprintf(tile
, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
1063 connector
->tile_group
->id
, connector
->tile_is_single_monitor
,
1064 connector
->num_h_tile
, connector
->num_v_tile
,
1065 connector
->tile_h_loc
, connector
->tile_v_loc
,
1066 connector
->tile_h_size
, connector
->tile_v_size
);
1068 ret
= drm_property_replace_global_blob(dev
,
1069 &connector
->tile_blob_ptr
,
1073 dev
->mode_config
.tile_property
);
1076 EXPORT_SYMBOL(drm_mode_connector_set_tile_property
);
1079 * drm_mode_connector_update_edid_property - update the edid property of a connector
1080 * @connector: drm connector
1081 * @edid: new value of the edid property
1083 * This function creates a new blob modeset object and assigns its id to the
1084 * connector's edid property.
1087 * Zero on success, negative errno on failure.
1089 int drm_mode_connector_update_edid_property(struct drm_connector
*connector
,
1090 const struct edid
*edid
)
1092 struct drm_device
*dev
= connector
->dev
;
1096 /* ignore requests to set edid when overridden */
1097 if (connector
->override_edid
)
1101 size
= EDID_LENGTH
* (1 + edid
->extensions
);
1103 ret
= drm_property_replace_global_blob(dev
,
1104 &connector
->edid_blob_ptr
,
1108 dev
->mode_config
.edid_property
);
1111 EXPORT_SYMBOL(drm_mode_connector_update_edid_property
);
1114 * drm_mode_connector_set_link_status_property - Set link status property of a connector
1115 * @connector: drm connector
1116 * @link_status: new value of link status property (0: Good, 1: Bad)
1118 * In usual working scenario, this link status property will always be set to
1119 * "GOOD". If something fails during or after a mode set, the kernel driver
1120 * may set this link status property to "BAD". The caller then needs to send a
1121 * hotplug uevent for userspace to re-check the valid modes through
1122 * GET_CONNECTOR_IOCTL and retry modeset.
1124 * Note: Drivers cannot rely on userspace to support this property and
1125 * issue a modeset. As such, they may choose to handle issues (like
1126 * re-training a link) without userspace's intervention.
1128 * The reason for adding this property is to handle link training failures, but
1129 * it is not limited to DP or link training. For example, if we implement
1130 * asynchronous setcrtc, this property can be used to report any failures in that.
1132 void drm_mode_connector_set_link_status_property(struct drm_connector
*connector
,
1133 uint64_t link_status
)
1135 struct drm_device
*dev
= connector
->dev
;
1137 drm_modeset_lock(&dev
->mode_config
.connection_mutex
, NULL
);
1138 connector
->state
->link_status
= link_status
;
1139 drm_modeset_unlock(&dev
->mode_config
.connection_mutex
);
1141 EXPORT_SYMBOL(drm_mode_connector_set_link_status_property
);
1143 int drm_mode_connector_set_obj_prop(struct drm_mode_object
*obj
,
1144 struct drm_property
*property
,
1148 struct drm_connector
*connector
= obj_to_connector(obj
);
1150 /* Do DPMS ourselves */
1151 if (property
== connector
->dev
->mode_config
.dpms_property
) {
1152 ret
= (*connector
->funcs
->dpms
)(connector
, (int)value
);
1153 } else if (connector
->funcs
->set_property
)
1154 ret
= connector
->funcs
->set_property(connector
, property
, value
);
1156 /* store the property value if successful */
1158 drm_object_property_set_value(&connector
->base
, property
, value
);
1162 int drm_mode_connector_property_set_ioctl(struct drm_device
*dev
,
1163 void *data
, struct drm_file
*file_priv
)
1165 struct drm_mode_connector_set_property
*conn_set_prop
= data
;
1166 struct drm_mode_obj_set_property obj_set_prop
= {
1167 .value
= conn_set_prop
->value
,
1168 .prop_id
= conn_set_prop
->prop_id
,
1169 .obj_id
= conn_set_prop
->connector_id
,
1170 .obj_type
= DRM_MODE_OBJECT_CONNECTOR
1173 /* It does all the locking and checking we need */
1174 return drm_mode_obj_set_property_ioctl(dev
, &obj_set_prop
, file_priv
);
1177 static struct drm_encoder
*drm_connector_get_encoder(struct drm_connector
*connector
)
1179 /* For atomic drivers only state objects are synchronously updated and
1180 * protected by modeset locks, so check those first. */
1181 if (connector
->state
)
1182 return connector
->state
->best_encoder
;
1183 return connector
->encoder
;
1186 static bool drm_mode_expose_to_userspace(const struct drm_display_mode
*mode
,
1187 const struct drm_file
*file_priv
)
1190 * If user-space hasn't configured the driver to expose the stereo 3D
1191 * modes, don't expose them.
1193 if (!file_priv
->stereo_allowed
&& drm_mode_is_stereo(mode
))
1199 int drm_mode_getconnector(struct drm_device
*dev
, void *data
,
1200 struct drm_file
*file_priv
)
1202 struct drm_mode_get_connector
*out_resp
= data
;
1203 struct drm_connector
*connector
;
1204 struct drm_encoder
*encoder
;
1205 struct drm_display_mode
*mode
;
1207 int encoders_count
= 0;
1211 struct drm_mode_modeinfo u_mode
;
1212 struct drm_mode_modeinfo __user
*mode_ptr
;
1213 uint32_t __user
*encoder_ptr
;
1215 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
1218 memset(&u_mode
, 0, sizeof(struct drm_mode_modeinfo
));
1220 connector
= drm_connector_lookup(dev
, out_resp
->connector_id
);
1224 drm_modeset_lock(&dev
->mode_config
.connection_mutex
, NULL
);
1225 encoder
= drm_connector_get_encoder(connector
);
1227 out_resp
->encoder_id
= encoder
->base
.id
;
1229 out_resp
->encoder_id
= 0;
1231 ret
= drm_mode_object_get_properties(&connector
->base
, file_priv
->atomic
,
1232 (uint32_t __user
*)(unsigned long)(out_resp
->props_ptr
),
1233 (uint64_t __user
*)(unsigned long)(out_resp
->prop_values_ptr
),
1234 &out_resp
->count_props
);
1235 drm_modeset_unlock(&dev
->mode_config
.connection_mutex
);
1239 for (i
= 0; i
< DRM_CONNECTOR_MAX_ENCODER
; i
++)
1240 if (connector
->encoder_ids
[i
] != 0)
1243 if ((out_resp
->count_encoders
>= encoders_count
) && encoders_count
) {
1245 encoder_ptr
= (uint32_t __user
*)(unsigned long)(out_resp
->encoders_ptr
);
1246 for (i
= 0; i
< DRM_CONNECTOR_MAX_ENCODER
; i
++) {
1247 if (connector
->encoder_ids
[i
] != 0) {
1248 if (put_user(connector
->encoder_ids
[i
],
1249 encoder_ptr
+ copied
)) {
1257 out_resp
->count_encoders
= encoders_count
;
1259 out_resp
->connector_id
= connector
->base
.id
;
1260 out_resp
->connector_type
= connector
->connector_type
;
1261 out_resp
->connector_type_id
= connector
->connector_type_id
;
1263 mutex_lock(&dev
->mode_config
.mutex
);
1264 if (out_resp
->count_modes
== 0) {
1265 connector
->funcs
->fill_modes(connector
,
1266 dev
->mode_config
.max_width
,
1267 dev
->mode_config
.max_height
);
1270 out_resp
->mm_width
= connector
->display_info
.width_mm
;
1271 out_resp
->mm_height
= connector
->display_info
.height_mm
;
1272 out_resp
->subpixel
= connector
->display_info
.subpixel_order
;
1273 out_resp
->connection
= connector
->status
;
1275 /* delayed so we get modes regardless of pre-fill_modes state */
1276 list_for_each_entry(mode
, &connector
->modes
, head
)
1277 if (drm_mode_expose_to_userspace(mode
, file_priv
))
1281 * This ioctl is called twice, once to determine how much space is
1282 * needed, and the 2nd time to fill it.
1284 if ((out_resp
->count_modes
>= mode_count
) && mode_count
) {
1286 mode_ptr
= (struct drm_mode_modeinfo __user
*)(unsigned long)out_resp
->modes_ptr
;
1287 list_for_each_entry(mode
, &connector
->modes
, head
) {
1288 if (!drm_mode_expose_to_userspace(mode
, file_priv
))
1291 drm_mode_convert_to_umode(&u_mode
, mode
);
1292 if (copy_to_user(mode_ptr
+ copied
,
1293 &u_mode
, sizeof(u_mode
))) {
1300 out_resp
->count_modes
= mode_count
;
1302 mutex_unlock(&dev
->mode_config
.mutex
);
1304 drm_connector_unreference(connector
);
1313 * Tile groups are used to represent tiled monitors with a unique integer
1314 * identifier. Tiled monitors using DisplayID v1.3 have a unique 8-byte handle,
1315 * we store this in a tile group, so we have a common identifier for all tiles
1316 * in a monitor group. The property is called "TILE". Drivers can manage tile
1317 * groups using drm_mode_create_tile_group(), drm_mode_put_tile_group() and
1318 * drm_mode_get_tile_group(). But this is only needed for internal panels where
1319 * the tile group information is exposed through a non-standard way.
1322 static void drm_tile_group_free(struct kref
*kref
)
1324 struct drm_tile_group
*tg
= container_of(kref
, struct drm_tile_group
, refcount
);
1325 struct drm_device
*dev
= tg
->dev
;
1326 mutex_lock(&dev
->mode_config
.idr_mutex
);
1327 idr_remove(&dev
->mode_config
.tile_idr
, tg
->id
);
1328 mutex_unlock(&dev
->mode_config
.idr_mutex
);
1333 * drm_mode_put_tile_group - drop a reference to a tile group.
1335 * @tg: tile group to drop reference to.
1337 * drop reference to tile group and free if 0.
1339 void drm_mode_put_tile_group(struct drm_device
*dev
,
1340 struct drm_tile_group
*tg
)
1342 kref_put(&tg
->refcount
, drm_tile_group_free
);
1344 EXPORT_SYMBOL(drm_mode_put_tile_group
);
1347 * drm_mode_get_tile_group - get a reference to an existing tile group
1349 * @topology: 8-bytes unique per monitor.
1351 * Use the unique bytes to get a reference to an existing tile group.
1354 * tile group or NULL if not found.
1356 struct drm_tile_group
*drm_mode_get_tile_group(struct drm_device
*dev
,
1359 struct drm_tile_group
*tg
;
1361 mutex_lock(&dev
->mode_config
.idr_mutex
);
1362 idr_for_each_entry(&dev
->mode_config
.tile_idr
, tg
, id
) {
1363 if (!memcmp(tg
->group_data
, topology
, 8)) {
1364 if (!kref_get_unless_zero(&tg
->refcount
))
1366 mutex_unlock(&dev
->mode_config
.idr_mutex
);
1370 mutex_unlock(&dev
->mode_config
.idr_mutex
);
1373 EXPORT_SYMBOL(drm_mode_get_tile_group
);
1376 * drm_mode_create_tile_group - create a tile group from a displayid description
1378 * @topology: 8-bytes unique per monitor.
1380 * Create a tile group for the unique monitor, and get a unique
1381 * identifier for the tile group.
1384 * new tile group or error.
1386 struct drm_tile_group
*drm_mode_create_tile_group(struct drm_device
*dev
,
1389 struct drm_tile_group
*tg
;
1392 tg
= kzalloc(sizeof(*tg
), GFP_KERNEL
);
1394 return ERR_PTR(-ENOMEM
);
1396 kref_init(&tg
->refcount
);
1397 memcpy(tg
->group_data
, topology
, 8);
1400 mutex_lock(&dev
->mode_config
.idr_mutex
);
1401 ret
= idr_alloc(&dev
->mode_config
.tile_idr
, tg
, 1, 0, GFP_KERNEL
);
1409 mutex_unlock(&dev
->mode_config
.idr_mutex
);
1412 EXPORT_SYMBOL(drm_mode_create_tile_group
);