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
23 #include <drm/drm_connector.h>
24 #include <drm/drm_edid.h>
25 #include <drm/drm_encoder.h>
26 #include <drm/drm_utils.h>
27 #include <drm/drm_print.h>
28 #include <drm/drm_drv.h>
29 #include <drm/drm_file.h>
30 #include <drm/drm_sysfs.h>
32 #include <linux/uaccess.h>
34 #include "drm_crtc_internal.h"
35 #include "drm_internal.h"
40 * In DRM connectors are the general abstraction for display sinks, and include
41 * also fixed panels or anything else that can display pixels in some form. As
42 * opposed to all other KMS objects representing hardware (like CRTC, encoder or
43 * plane abstractions) connectors can be hotplugged and unplugged at runtime.
44 * Hence they are reference-counted using drm_connector_get() and
45 * drm_connector_put().
47 * KMS driver must create, initialize, register and attach at a &struct
48 * drm_connector for each such sink. The instance is created as other KMS
49 * objects and initialized by setting the following fields. The connector is
50 * initialized with a call to drm_connector_init() with a pointer to the
51 * &struct drm_connector_funcs and a connector type, and then exposed to
52 * userspace with a call to drm_connector_register().
54 * Connectors must be attached to an encoder to be used. For devices that map
55 * connectors to encoders 1:1, the connector should be attached at
56 * initialization time with a call to drm_connector_attach_encoder(). The
57 * driver must also set the &drm_connector.encoder field to point to the
60 * For connectors which are not fixed (like built-in panels) the driver needs to
61 * support hotplug notifications. The simplest way to do that is by using the
62 * probe helpers, see drm_kms_helper_poll_init() for connectors which don't have
63 * hardware support for hotplug interrupts. Connectors with hardware hotplug
64 * support can instead use e.g. drm_helper_hpd_irq_event().
68 * Global connector list for drm_connector_find_by_fwnode().
69 * Note drm_connector_[un]register() first take connector->lock and then
70 * take the connector_list_lock.
72 static DEFINE_MUTEX(connector_list_lock);
73 static LIST_HEAD(connector_list);
75 struct drm_conn_prop_enum_list {
82 * Connector and encoder types.
84 static struct drm_conn_prop_enum_list drm_connector_enum_list[] = {
85 { DRM_MODE_CONNECTOR_Unknown, "Unknown" },
86 { DRM_MODE_CONNECTOR_VGA, "VGA" },
87 { DRM_MODE_CONNECTOR_DVII, "DVI-I" },
88 { DRM_MODE_CONNECTOR_DVID, "DVI-D" },
89 { DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
90 { DRM_MODE_CONNECTOR_Composite, "Composite" },
91 { DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
92 { DRM_MODE_CONNECTOR_LVDS, "LVDS" },
93 { DRM_MODE_CONNECTOR_Component, "Component" },
94 { DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
95 { DRM_MODE_CONNECTOR_DisplayPort, "DP" },
96 { DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
97 { DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
98 { DRM_MODE_CONNECTOR_TV, "TV" },
99 { DRM_MODE_CONNECTOR_eDP, "eDP" },
100 { DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
101 { DRM_MODE_CONNECTOR_DSI, "DSI" },
102 { DRM_MODE_CONNECTOR_DPI, "DPI" },
103 { DRM_MODE_CONNECTOR_WRITEBACK, "Writeback" },
104 { DRM_MODE_CONNECTOR_SPI, "SPI" },
107 void drm_connector_ida_init(void)
111 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
112 ida_init(&drm_connector_enum_list[i].ida);
115 void drm_connector_ida_destroy(void)
119 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
120 ida_destroy(&drm_connector_enum_list[i].ida);
124 * drm_get_connector_type_name - return a string for connector type
125 * @type: The connector type (DRM_MODE_CONNECTOR_*)
127 * Returns: the name of the connector type, or NULL if the type is not valid.
129 const char *drm_get_connector_type_name(unsigned int type)
131 if (type < ARRAY_SIZE(drm_connector_enum_list))
132 return drm_connector_enum_list[type].name;
136 EXPORT_SYMBOL(drm_get_connector_type_name);
139 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
140 * @connector: connector to query
142 * The kernel supports per-connector configuration of its consoles through
143 * use of the video= parameter. This function parses that option and
144 * extracts the user's specified mode (or enable/disable status) for a
145 * particular connector. This is typically only used during the early fbdev
148 static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
150 struct drm_cmdline_mode *mode = &connector->cmdline_mode;
153 if (fb_get_options(connector->name, &option))
156 if (!drm_mode_parse_command_line_for_connector(option,
162 DRM_INFO("forcing %s connector %s\n", connector->name,
163 drm_get_connector_force_name(mode->force));
164 connector->force = mode->force;
167 if (mode->panel_orientation != DRM_MODE_PANEL_ORIENTATION_UNKNOWN) {
168 DRM_INFO("cmdline forces connector %s panel_orientation to %d\n",
169 connector->name, mode->panel_orientation);
170 drm_connector_set_panel_orientation(connector,
171 mode->panel_orientation);
174 DRM_DEBUG_KMS("cmdline mode for connector %s %s %dx%d@%dHz%s%s%s\n",
175 connector->name, mode->name,
176 mode->xres, mode->yres,
177 mode->refresh_specified ? mode->refresh : 60,
178 mode->rb ? " reduced blanking" : "",
179 mode->margins ? " with margins" : "",
180 mode->interlace ? " interlaced" : "");
183 static void drm_connector_free(struct kref *kref)
185 struct drm_connector *connector =
186 container_of(kref, struct drm_connector, base.refcount);
187 struct drm_device *dev = connector->dev;
189 drm_mode_object_unregister(dev, &connector->base);
190 connector->funcs->destroy(connector);
193 void drm_connector_free_work_fn(struct work_struct *work)
195 struct drm_connector *connector, *n;
196 struct drm_device *dev =
197 container_of(work, struct drm_device, mode_config.connector_free_work);
198 struct drm_mode_config *config = &dev->mode_config;
200 struct llist_node *freed;
202 spin_lock_irqsave(&config->connector_list_lock, flags);
203 freed = llist_del_all(&config->connector_free_list);
204 spin_unlock_irqrestore(&config->connector_list_lock, flags);
206 llist_for_each_entry_safe(connector, n, freed, free_node) {
207 drm_mode_object_unregister(dev, &connector->base);
208 connector->funcs->destroy(connector);
213 * drm_connector_init - Init a preallocated connector
215 * @connector: the connector to init
216 * @funcs: callbacks for this connector
217 * @connector_type: user visible type of the connector
219 * Initialises a preallocated connector. Connectors should be
220 * subclassed as part of driver connector objects.
223 * Zero on success, error code on failure.
225 int drm_connector_init(struct drm_device *dev,
226 struct drm_connector *connector,
227 const struct drm_connector_funcs *funcs,
230 struct drm_mode_config *config = &dev->mode_config;
232 struct ida *connector_ida =
233 &drm_connector_enum_list[connector_type].ida;
235 WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
236 (!funcs->atomic_destroy_state ||
237 !funcs->atomic_duplicate_state));
239 ret = __drm_mode_object_add(dev, &connector->base,
240 DRM_MODE_OBJECT_CONNECTOR,
241 false, drm_connector_free);
245 connector->base.properties = &connector->properties;
246 connector->dev = dev;
247 connector->funcs = funcs;
249 /* connector index is used with 32bit bitmasks */
250 ret = ida_simple_get(&config->connector_ida, 0, 32, GFP_KERNEL);
252 DRM_DEBUG_KMS("Failed to allocate %s connector index: %d\n",
253 drm_connector_enum_list[connector_type].name,
257 connector->index = ret;
260 connector->connector_type = connector_type;
261 connector->connector_type_id =
262 ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
263 if (connector->connector_type_id < 0) {
264 ret = connector->connector_type_id;
268 kasprintf(GFP_KERNEL, "%s-%d",
269 drm_connector_enum_list[connector_type].name,
270 connector->connector_type_id);
271 if (!connector->name) {
273 goto out_put_type_id;
276 INIT_LIST_HEAD(&connector->global_connector_list_entry);
277 INIT_LIST_HEAD(&connector->probed_modes);
278 INIT_LIST_HEAD(&connector->modes);
279 mutex_init(&connector->mutex);
280 connector->edid_blob_ptr = NULL;
281 connector->epoch_counter = 0;
282 connector->tile_blob_ptr = NULL;
283 connector->status = connector_status_unknown;
284 connector->display_info.panel_orientation =
285 DRM_MODE_PANEL_ORIENTATION_UNKNOWN;
287 drm_connector_get_cmdline_mode(connector);
289 /* We should add connectors at the end to avoid upsetting the connector
291 spin_lock_irq(&config->connector_list_lock);
292 list_add_tail(&connector->head, &config->connector_list);
293 config->num_connector++;
294 spin_unlock_irq(&config->connector_list_lock);
296 if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL &&
297 connector_type != DRM_MODE_CONNECTOR_WRITEBACK)
298 drm_connector_attach_edid_property(connector);
300 drm_object_attach_property(&connector->base,
301 config->dpms_property, 0);
303 drm_object_attach_property(&connector->base,
304 config->link_status_property,
307 drm_object_attach_property(&connector->base,
308 config->non_desktop_property,
310 drm_object_attach_property(&connector->base,
311 config->tile_property,
314 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
315 drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
318 connector->debugfs_entry = NULL;
321 ida_simple_remove(connector_ida, connector->connector_type_id);
324 ida_simple_remove(&config->connector_ida, connector->index);
327 drm_mode_object_unregister(dev, &connector->base);
331 EXPORT_SYMBOL(drm_connector_init);
334 * drm_connector_init_with_ddc - Init a preallocated connector
336 * @connector: the connector to init
337 * @funcs: callbacks for this connector
338 * @connector_type: user visible type of the connector
339 * @ddc: pointer to the associated ddc adapter
341 * Initialises a preallocated connector. Connectors should be
342 * subclassed as part of driver connector objects.
344 * Ensures that the ddc field of the connector is correctly set.
347 * Zero on success, error code on failure.
349 int drm_connector_init_with_ddc(struct drm_device *dev,
350 struct drm_connector *connector,
351 const struct drm_connector_funcs *funcs,
353 struct i2c_adapter *ddc)
357 ret = drm_connector_init(dev, connector, funcs, connector_type);
361 /* provide ddc symlink in sysfs */
362 connector->ddc = ddc;
366 EXPORT_SYMBOL(drm_connector_init_with_ddc);
369 * drm_connector_attach_edid_property - attach edid property.
370 * @connector: the connector
372 * Some connector types like DRM_MODE_CONNECTOR_VIRTUAL do not get a
373 * edid property attached by default. This function can be used to
374 * explicitly enable the edid property in these cases.
376 void drm_connector_attach_edid_property(struct drm_connector *connector)
378 struct drm_mode_config *config = &connector->dev->mode_config;
380 drm_object_attach_property(&connector->base,
381 config->edid_property,
384 EXPORT_SYMBOL(drm_connector_attach_edid_property);
387 * drm_connector_attach_encoder - attach a connector to an encoder
388 * @connector: connector to attach
389 * @encoder: encoder to attach @connector to
391 * This function links up a connector to an encoder. Note that the routing
392 * restrictions between encoders and crtcs are exposed to userspace through the
393 * possible_clones and possible_crtcs bitmasks.
396 * Zero on success, negative errno on failure.
398 int drm_connector_attach_encoder(struct drm_connector *connector,
399 struct drm_encoder *encoder)
402 * In the past, drivers have attempted to model the static association
403 * of connector to encoder in simple connector/encoder devices using a
404 * direct assignment of connector->encoder = encoder. This connection
405 * is a logical one and the responsibility of the core, so drivers are
406 * expected not to mess with this.
408 * Note that the error return should've been enough here, but a large
409 * majority of drivers ignores the return value, so add in a big WARN
410 * to get people's attention.
412 if (WARN_ON(connector->encoder))
415 connector->possible_encoders |= drm_encoder_mask(encoder);
419 EXPORT_SYMBOL(drm_connector_attach_encoder);
422 * drm_connector_has_possible_encoder - check if the connector and encoder are
423 * associated with each other
424 * @connector: the connector
425 * @encoder: the encoder
428 * True if @encoder is one of the possible encoders for @connector.
430 bool drm_connector_has_possible_encoder(struct drm_connector *connector,
431 struct drm_encoder *encoder)
433 return connector->possible_encoders & drm_encoder_mask(encoder);
435 EXPORT_SYMBOL(drm_connector_has_possible_encoder);
437 static void drm_mode_remove(struct drm_connector *connector,
438 struct drm_display_mode *mode)
440 list_del(&mode->head);
441 drm_mode_destroy(connector->dev, mode);
445 * drm_connector_cleanup - cleans up an initialised connector
446 * @connector: connector to cleanup
448 * Cleans up the connector but doesn't free the object.
450 void drm_connector_cleanup(struct drm_connector *connector)
452 struct drm_device *dev = connector->dev;
453 struct drm_display_mode *mode, *t;
455 /* The connector should have been removed from userspace long before
456 * it is finally destroyed.
458 if (WARN_ON(connector->registration_state ==
459 DRM_CONNECTOR_REGISTERED))
460 drm_connector_unregister(connector);
462 if (connector->tile_group) {
463 drm_mode_put_tile_group(dev, connector->tile_group);
464 connector->tile_group = NULL;
467 list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
468 drm_mode_remove(connector, mode);
470 list_for_each_entry_safe(mode, t, &connector->modes, head)
471 drm_mode_remove(connector, mode);
473 ida_simple_remove(&drm_connector_enum_list[connector->connector_type].ida,
474 connector->connector_type_id);
476 ida_simple_remove(&dev->mode_config.connector_ida,
479 kfree(connector->display_info.bus_formats);
480 drm_mode_object_unregister(dev, &connector->base);
481 kfree(connector->name);
482 connector->name = NULL;
483 fwnode_handle_put(connector->fwnode);
484 connector->fwnode = NULL;
485 spin_lock_irq(&dev->mode_config.connector_list_lock);
486 list_del(&connector->head);
487 dev->mode_config.num_connector--;
488 spin_unlock_irq(&dev->mode_config.connector_list_lock);
490 WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
491 if (connector->state && connector->funcs->atomic_destroy_state)
492 connector->funcs->atomic_destroy_state(connector,
495 mutex_destroy(&connector->mutex);
497 memset(connector, 0, sizeof(*connector));
500 drm_sysfs_hotplug_event(dev);
502 EXPORT_SYMBOL(drm_connector_cleanup);
505 * drm_connector_register - register a connector
506 * @connector: the connector to register
508 * Register userspace interfaces for a connector. Only call this for connectors
509 * which can be hotplugged after drm_dev_register() has been called already,
510 * e.g. DP MST connectors. All other connectors will be registered automatically
511 * when calling drm_dev_register().
514 * Zero on success, error code on failure.
516 int drm_connector_register(struct drm_connector *connector)
520 if (!connector->dev->registered)
523 mutex_lock(&connector->mutex);
524 if (connector->registration_state != DRM_CONNECTOR_INITIALIZING)
527 ret = drm_sysfs_connector_add(connector);
531 drm_debugfs_connector_add(connector);
533 if (connector->funcs->late_register) {
534 ret = connector->funcs->late_register(connector);
539 drm_mode_object_register(connector->dev, &connector->base);
541 connector->registration_state = DRM_CONNECTOR_REGISTERED;
543 /* Let userspace know we have a new connector */
544 drm_sysfs_hotplug_event(connector->dev);
546 mutex_lock(&connector_list_lock);
547 list_add_tail(&connector->global_connector_list_entry, &connector_list);
548 mutex_unlock(&connector_list_lock);
552 drm_debugfs_connector_remove(connector);
553 drm_sysfs_connector_remove(connector);
555 mutex_unlock(&connector->mutex);
558 EXPORT_SYMBOL(drm_connector_register);
561 * drm_connector_unregister - unregister a connector
562 * @connector: the connector to unregister
564 * Unregister userspace interfaces for a connector. Only call this for
565 * connectors which have registered explicitly by calling drm_dev_register(),
566 * since connectors are unregistered automatically when drm_dev_unregister() is
569 void drm_connector_unregister(struct drm_connector *connector)
571 mutex_lock(&connector->mutex);
572 if (connector->registration_state != DRM_CONNECTOR_REGISTERED) {
573 mutex_unlock(&connector->mutex);
577 mutex_lock(&connector_list_lock);
578 list_del_init(&connector->global_connector_list_entry);
579 mutex_unlock(&connector_list_lock);
581 if (connector->funcs->early_unregister)
582 connector->funcs->early_unregister(connector);
584 drm_sysfs_connector_remove(connector);
585 drm_debugfs_connector_remove(connector);
587 connector->registration_state = DRM_CONNECTOR_UNREGISTERED;
588 mutex_unlock(&connector->mutex);
590 EXPORT_SYMBOL(drm_connector_unregister);
592 void drm_connector_unregister_all(struct drm_device *dev)
594 struct drm_connector *connector;
595 struct drm_connector_list_iter conn_iter;
597 drm_connector_list_iter_begin(dev, &conn_iter);
598 drm_for_each_connector_iter(connector, &conn_iter)
599 drm_connector_unregister(connector);
600 drm_connector_list_iter_end(&conn_iter);
603 int drm_connector_register_all(struct drm_device *dev)
605 struct drm_connector *connector;
606 struct drm_connector_list_iter conn_iter;
609 drm_connector_list_iter_begin(dev, &conn_iter);
610 drm_for_each_connector_iter(connector, &conn_iter) {
611 ret = drm_connector_register(connector);
615 drm_connector_list_iter_end(&conn_iter);
618 drm_connector_unregister_all(dev);
623 * drm_get_connector_status_name - return a string for connector status
624 * @status: connector status to compute name of
626 * In contrast to the other drm_get_*_name functions this one here returns a
627 * const pointer and hence is threadsafe.
629 const char *drm_get_connector_status_name(enum drm_connector_status status)
631 if (status == connector_status_connected)
633 else if (status == connector_status_disconnected)
634 return "disconnected";
638 EXPORT_SYMBOL(drm_get_connector_status_name);
641 * drm_get_connector_force_name - return a string for connector force
642 * @force: connector force to get name of
644 * Returns: const pointer to name.
646 const char *drm_get_connector_force_name(enum drm_connector_force force)
649 case DRM_FORCE_UNSPECIFIED:
650 return "unspecified";
655 case DRM_FORCE_ON_DIGITAL:
662 #ifdef CONFIG_LOCKDEP
663 static struct lockdep_map connector_list_iter_dep_map = {
664 .name = "drm_connector_list_iter"
669 * drm_connector_list_iter_begin - initialize a connector_list iterator
671 * @iter: connector_list iterator
673 * Sets @iter up to walk the &drm_mode_config.connector_list of @dev. @iter
674 * must always be cleaned up again by calling drm_connector_list_iter_end().
675 * Iteration itself happens using drm_connector_list_iter_next() or
676 * drm_for_each_connector_iter().
678 void drm_connector_list_iter_begin(struct drm_device *dev,
679 struct drm_connector_list_iter *iter)
683 lock_acquire_shared_recursive(&connector_list_iter_dep_map, 0, 1, NULL, _RET_IP_);
685 EXPORT_SYMBOL(drm_connector_list_iter_begin);
688 * Extra-safe connector put function that works in any context. Should only be
689 * used from the connector_iter functions, where we never really expect to
690 * actually release the connector when dropping our final reference.
693 __drm_connector_put_safe(struct drm_connector *conn)
695 struct drm_mode_config *config = &conn->dev->mode_config;
697 lockdep_assert_held(&config->connector_list_lock);
699 if (!refcount_dec_and_test(&conn->base.refcount.refcount))
702 llist_add(&conn->free_node, &config->connector_free_list);
703 schedule_work(&config->connector_free_work);
707 * drm_connector_list_iter_next - return next connector
708 * @iter: connector_list iterator
710 * Returns the next connector for @iter, or NULL when the list walk has
713 struct drm_connector *
714 drm_connector_list_iter_next(struct drm_connector_list_iter *iter)
716 struct drm_connector *old_conn = iter->conn;
717 struct drm_mode_config *config = &iter->dev->mode_config;
718 struct list_head *lhead;
721 spin_lock_irqsave(&config->connector_list_lock, flags);
722 lhead = old_conn ? &old_conn->head : &config->connector_list;
725 if (lhead->next == &config->connector_list) {
731 iter->conn = list_entry(lhead, struct drm_connector, head);
733 /* loop until it's not a zombie connector */
734 } while (!kref_get_unless_zero(&iter->conn->base.refcount));
737 __drm_connector_put_safe(old_conn);
738 spin_unlock_irqrestore(&config->connector_list_lock, flags);
742 EXPORT_SYMBOL(drm_connector_list_iter_next);
745 * drm_connector_list_iter_end - tear down a connector_list iterator
746 * @iter: connector_list iterator
748 * Tears down @iter and releases any resources (like &drm_connector references)
749 * acquired while walking the list. This must always be called, both when the
750 * iteration completes fully or when it was aborted without walking the entire
753 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter)
755 struct drm_mode_config *config = &iter->dev->mode_config;
760 spin_lock_irqsave(&config->connector_list_lock, flags);
761 __drm_connector_put_safe(iter->conn);
762 spin_unlock_irqrestore(&config->connector_list_lock, flags);
764 lock_release(&connector_list_iter_dep_map, _RET_IP_);
766 EXPORT_SYMBOL(drm_connector_list_iter_end);
768 static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
769 { SubPixelUnknown, "Unknown" },
770 { SubPixelHorizontalRGB, "Horizontal RGB" },
771 { SubPixelHorizontalBGR, "Horizontal BGR" },
772 { SubPixelVerticalRGB, "Vertical RGB" },
773 { SubPixelVerticalBGR, "Vertical BGR" },
774 { SubPixelNone, "None" },
778 * drm_get_subpixel_order_name - return a string for a given subpixel enum
779 * @order: enum of subpixel_order
781 * Note you could abuse this and return something out of bounds, but that
782 * would be a caller error. No unscrubbed user data should make it here.
784 const char *drm_get_subpixel_order_name(enum subpixel_order order)
786 return drm_subpixel_enum_list[order].name;
788 EXPORT_SYMBOL(drm_get_subpixel_order_name);
790 static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
791 { DRM_MODE_DPMS_ON, "On" },
792 { DRM_MODE_DPMS_STANDBY, "Standby" },
793 { DRM_MODE_DPMS_SUSPEND, "Suspend" },
794 { DRM_MODE_DPMS_OFF, "Off" }
796 DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
798 static const struct drm_prop_enum_list drm_link_status_enum_list[] = {
799 { DRM_MODE_LINK_STATUS_GOOD, "Good" },
800 { DRM_MODE_LINK_STATUS_BAD, "Bad" },
804 * drm_display_info_set_bus_formats - set the supported bus formats
805 * @info: display info to store bus formats in
806 * @formats: array containing the supported bus formats
807 * @num_formats: the number of entries in the fmts array
809 * Store the supported bus formats in display info structure.
810 * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
811 * a full list of available formats.
813 int drm_display_info_set_bus_formats(struct drm_display_info *info,
815 unsigned int num_formats)
819 if (!formats && num_formats)
822 if (formats && num_formats) {
823 fmts = kmemdup(formats, sizeof(*formats) * num_formats,
829 kfree(info->bus_formats);
830 info->bus_formats = fmts;
831 info->num_bus_formats = num_formats;
835 EXPORT_SYMBOL(drm_display_info_set_bus_formats);
837 /* Optional connector properties. */
838 static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
839 { DRM_MODE_SCALE_NONE, "None" },
840 { DRM_MODE_SCALE_FULLSCREEN, "Full" },
841 { DRM_MODE_SCALE_CENTER, "Center" },
842 { DRM_MODE_SCALE_ASPECT, "Full aspect" },
845 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
846 { DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
847 { DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
848 { DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
851 static const struct drm_prop_enum_list drm_content_type_enum_list[] = {
852 { DRM_MODE_CONTENT_TYPE_NO_DATA, "No Data" },
853 { DRM_MODE_CONTENT_TYPE_GRAPHICS, "Graphics" },
854 { DRM_MODE_CONTENT_TYPE_PHOTO, "Photo" },
855 { DRM_MODE_CONTENT_TYPE_CINEMA, "Cinema" },
856 { DRM_MODE_CONTENT_TYPE_GAME, "Game" },
859 static const struct drm_prop_enum_list drm_panel_orientation_enum_list[] = {
860 { DRM_MODE_PANEL_ORIENTATION_NORMAL, "Normal" },
861 { DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP, "Upside Down" },
862 { DRM_MODE_PANEL_ORIENTATION_LEFT_UP, "Left Side Up" },
863 { DRM_MODE_PANEL_ORIENTATION_RIGHT_UP, "Right Side Up" },
866 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
867 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
868 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
869 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
871 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
873 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
874 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
875 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
876 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
878 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
879 drm_dvi_i_subconnector_enum_list)
881 static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
882 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
883 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
884 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
885 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
886 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
888 DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
890 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
891 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
892 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
893 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
894 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
895 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
897 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
898 drm_tv_subconnector_enum_list)
900 static const struct drm_prop_enum_list drm_dp_subconnector_enum_list[] = {
901 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
902 { DRM_MODE_SUBCONNECTOR_VGA, "VGA" }, /* DP */
903 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DP */
904 { DRM_MODE_SUBCONNECTOR_HDMIA, "HDMI" }, /* DP */
905 { DRM_MODE_SUBCONNECTOR_DisplayPort, "DP" }, /* DP */
906 { DRM_MODE_SUBCONNECTOR_Wireless, "Wireless" }, /* DP */
907 { DRM_MODE_SUBCONNECTOR_Native, "Native" }, /* DP */
910 DRM_ENUM_NAME_FN(drm_get_dp_subconnector_name,
911 drm_dp_subconnector_enum_list)
913 static const struct drm_prop_enum_list hdmi_colorspaces[] = {
914 /* For Default case, driver will set the colorspace */
915 { DRM_MODE_COLORIMETRY_DEFAULT, "Default" },
916 /* Standard Definition Colorimetry based on CEA 861 */
917 { DRM_MODE_COLORIMETRY_SMPTE_170M_YCC, "SMPTE_170M_YCC" },
918 { DRM_MODE_COLORIMETRY_BT709_YCC, "BT709_YCC" },
919 /* Standard Definition Colorimetry based on IEC 61966-2-4 */
920 { DRM_MODE_COLORIMETRY_XVYCC_601, "XVYCC_601" },
921 /* High Definition Colorimetry based on IEC 61966-2-4 */
922 { DRM_MODE_COLORIMETRY_XVYCC_709, "XVYCC_709" },
923 /* Colorimetry based on IEC 61966-2-1/Amendment 1 */
924 { DRM_MODE_COLORIMETRY_SYCC_601, "SYCC_601" },
925 /* Colorimetry based on IEC 61966-2-5 [33] */
926 { DRM_MODE_COLORIMETRY_OPYCC_601, "opYCC_601" },
927 /* Colorimetry based on IEC 61966-2-5 */
928 { DRM_MODE_COLORIMETRY_OPRGB, "opRGB" },
929 /* Colorimetry based on ITU-R BT.2020 */
930 { DRM_MODE_COLORIMETRY_BT2020_CYCC, "BT2020_CYCC" },
931 /* Colorimetry based on ITU-R BT.2020 */
932 { DRM_MODE_COLORIMETRY_BT2020_RGB, "BT2020_RGB" },
933 /* Colorimetry based on ITU-R BT.2020 */
934 { DRM_MODE_COLORIMETRY_BT2020_YCC, "BT2020_YCC" },
935 /* Added as part of Additional Colorimetry Extension in 861.G */
936 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65, "DCI-P3_RGB_D65" },
937 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER, "DCI-P3_RGB_Theater" },
941 * As per DP 1.4a spec, 2.2.5.7.5 VSC SDP Payload for Pixel Encoding/Colorimetry
944 static const struct drm_prop_enum_list dp_colorspaces[] = {
945 /* For Default case, driver will set the colorspace */
946 { DRM_MODE_COLORIMETRY_DEFAULT, "Default" },
947 { DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED, "RGB_Wide_Gamut_Fixed_Point" },
948 /* Colorimetry based on scRGB (IEC 61966-2-2) */
949 { DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT, "RGB_Wide_Gamut_Floating_Point" },
950 /* Colorimetry based on IEC 61966-2-5 */
951 { DRM_MODE_COLORIMETRY_OPRGB, "opRGB" },
952 /* Colorimetry based on SMPTE RP 431-2 */
953 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65, "DCI-P3_RGB_D65" },
954 /* Colorimetry based on ITU-R BT.2020 */
955 { DRM_MODE_COLORIMETRY_BT2020_RGB, "BT2020_RGB" },
956 { DRM_MODE_COLORIMETRY_BT601_YCC, "BT601_YCC" },
957 { DRM_MODE_COLORIMETRY_BT709_YCC, "BT709_YCC" },
958 /* Standard Definition Colorimetry based on IEC 61966-2-4 */
959 { DRM_MODE_COLORIMETRY_XVYCC_601, "XVYCC_601" },
960 /* High Definition Colorimetry based on IEC 61966-2-4 */
961 { DRM_MODE_COLORIMETRY_XVYCC_709, "XVYCC_709" },
962 /* Colorimetry based on IEC 61966-2-1/Amendment 1 */
963 { DRM_MODE_COLORIMETRY_SYCC_601, "SYCC_601" },
964 /* Colorimetry based on IEC 61966-2-5 [33] */
965 { DRM_MODE_COLORIMETRY_OPYCC_601, "opYCC_601" },
966 /* Colorimetry based on ITU-R BT.2020 */
967 { DRM_MODE_COLORIMETRY_BT2020_CYCC, "BT2020_CYCC" },
968 /* Colorimetry based on ITU-R BT.2020 */
969 { DRM_MODE_COLORIMETRY_BT2020_YCC, "BT2020_YCC" },
973 * DOC: standard connector properties
975 * DRM connectors have a few standardized properties:
978 * Blob property which contains the current EDID read from the sink. This
979 * is useful to parse sink identification information like vendor, model
980 * and serial. Drivers should update this property by calling
981 * drm_connector_update_edid_property(), usually after having parsed
982 * the EDID using drm_add_edid_modes(). Userspace cannot change this
985 * Legacy property for setting the power state of the connector. For atomic
986 * drivers this is only provided for backwards compatibility with existing
987 * drivers, it remaps to controlling the "ACTIVE" property on the CRTC the
988 * connector is linked to. Drivers should never set this property directly,
989 * it is handled by the DRM core by calling the &drm_connector_funcs.dpms
990 * callback. For atomic drivers the remapping to the "ACTIVE" property is
991 * implemented in the DRM core.
993 * Note that this property cannot be set through the MODE_ATOMIC ioctl,
994 * userspace must use "ACTIVE" on the CRTC instead.
998 * For userspace also running on legacy drivers the "DPMS" semantics are a
999 * lot more complicated. First, userspace cannot rely on the "DPMS" value
1000 * returned by the GETCONNECTOR actually reflecting reality, because many
1001 * drivers fail to update it. For atomic drivers this is taken care of in
1002 * drm_atomic_helper_update_legacy_modeset_state().
1004 * The second issue is that the DPMS state is only well-defined when the
1005 * connector is connected to a CRTC. In atomic the DRM core enforces that
1006 * "ACTIVE" is off in such a case, no such checks exists for "DPMS".
1008 * Finally, when enabling an output using the legacy SETCONFIG ioctl then
1009 * "DPMS" is forced to ON. But see above, that might not be reflected in
1010 * the software value on legacy drivers.
1012 * Summarizing: Only set "DPMS" when the connector is known to be enabled,
1013 * assume that a successful SETCONFIG call also sets "DPMS" to on, and
1014 * never read back the value of "DPMS" because it can be incorrect.
1016 * Connector path property to identify how this sink is physically
1017 * connected. Used by DP MST. This should be set by calling
1018 * drm_connector_set_path_property(), in the case of DP MST with the
1019 * path property the MST manager created. Userspace cannot change this
1022 * Connector tile group property to indicate how a set of DRM connector
1023 * compose together into one logical screen. This is used by both high-res
1024 * external screens (often only using a single cable, but exposing multiple
1025 * DP MST sinks), or high-res integrated panels (like dual-link DSI) which
1026 * are not gen-locked. Note that for tiled panels which are genlocked, like
1027 * dual-link LVDS or dual-link DSI, the driver should try to not expose the
1028 * tiling and virtualise both &drm_crtc and &drm_plane if needed. Drivers
1029 * should update this value using drm_connector_set_tile_property().
1030 * Userspace cannot change this property.
1032 * Connector link-status property to indicate the status of link. The
1033 * default value of link-status is "GOOD". If something fails during or
1034 * after modeset, the kernel driver may set this to "BAD" and issue a
1035 * hotplug uevent. Drivers should update this value using
1036 * drm_connector_set_link_status_property().
1038 * When user-space receives the hotplug uevent and detects a "BAD"
1039 * link-status, the sink doesn't receive pixels anymore (e.g. the screen
1040 * becomes completely black). The list of available modes may have
1041 * changed. User-space is expected to pick a new mode if the current one
1042 * has disappeared and perform a new modeset with link-status set to
1043 * "GOOD" to re-enable the connector.
1045 * If multiple connectors share the same CRTC and one of them gets a "BAD"
1046 * link-status, the other are unaffected (ie. the sinks still continue to
1049 * When user-space performs an atomic commit on a connector with a "BAD"
1050 * link-status without resetting the property to "GOOD", the sink may
1051 * still not receive pixels. When user-space performs an atomic commit
1052 * which resets the link-status property to "GOOD" without the
1053 * ALLOW_MODESET flag set, it might fail because a modeset is required.
1055 * User-space can only change link-status to "GOOD", changing it to "BAD"
1058 * For backwards compatibility with non-atomic userspace the kernel
1059 * tries to automatically set the link-status back to "GOOD" in the
1060 * SETCRTC IOCTL. This might fail if the mode is no longer valid, similar
1061 * to how it might fail if a different screen has been connected in the
1064 * Indicates the output should be ignored for purposes of displaying a
1065 * standard desktop environment or console. This is most likely because
1066 * the output device is not rectilinear.
1067 * Content Protection:
1068 * This property is used by userspace to request the kernel protect future
1069 * content communicated over the link. When requested, kernel will apply
1070 * the appropriate means of protection (most often HDCP), and use the
1071 * property to tell userspace the protection is active.
1073 * Drivers can set this up by calling
1074 * drm_connector_attach_content_protection_property() on initialization.
1076 * The value of this property can be one of the following:
1078 * DRM_MODE_CONTENT_PROTECTION_UNDESIRED = 0
1079 * The link is not protected, content is transmitted in the clear.
1080 * DRM_MODE_CONTENT_PROTECTION_DESIRED = 1
1081 * Userspace has requested content protection, but the link is not
1082 * currently protected. When in this state, kernel should enable
1083 * Content Protection as soon as possible.
1084 * DRM_MODE_CONTENT_PROTECTION_ENABLED = 2
1085 * Userspace has requested content protection, and the link is
1086 * protected. Only the driver can set the property to this value.
1087 * If userspace attempts to set to ENABLED, kernel will return
1092 * - DESIRED state should be preserved until userspace de-asserts it by
1093 * setting the property to UNDESIRED. This means ENABLED should only
1094 * transition to UNDESIRED when the user explicitly requests it.
1095 * - If the state is DESIRED, kernel should attempt to re-authenticate the
1096 * link whenever possible. This includes across disable/enable, dpms,
1097 * hotplug, downstream device changes, link status failures, etc..
1098 * - Kernel sends uevent with the connector id and property id through
1099 * @drm_hdcp_update_content_protection, upon below kernel triggered
1102 * - DESIRED -> ENABLED (authentication success)
1103 * - ENABLED -> DESIRED (termination of authentication)
1104 * - Please note no uevents for userspace triggered property state changes,
1105 * which can't fail such as
1107 * - DESIRED/ENABLED -> UNDESIRED
1108 * - UNDESIRED -> DESIRED
1109 * - Userspace is responsible for polling the property or listen to uevents
1110 * to determine when the value transitions from ENABLED to DESIRED.
1111 * This signifies the link is no longer protected and userspace should
1112 * take appropriate action (whatever that might be).
1114 * HDCP Content Type:
1115 * This Enum property is used by the userspace to declare the content type
1116 * of the display stream, to kernel. Here display stream stands for any
1117 * display content that userspace intended to display through HDCP
1120 * Content Type of a stream is decided by the owner of the stream, as
1121 * "HDCP Type0" or "HDCP Type1".
1123 * The value of the property can be one of the below:
1124 * - "HDCP Type0": DRM_MODE_HDCP_CONTENT_TYPE0 = 0
1125 * - "HDCP Type1": DRM_MODE_HDCP_CONTENT_TYPE1 = 1
1127 * When kernel starts the HDCP authentication (see "Content Protection"
1128 * for details), it uses the content type in "HDCP Content Type"
1129 * for performing the HDCP authentication with the display sink.
1131 * Please note in HDCP spec versions, a link can be authenticated with
1132 * HDCP 2.2 for Content Type 0/Content Type 1. Where as a link can be
1133 * authenticated with HDCP1.4 only for Content Type 0(though it is implicit
1134 * in nature. As there is no reference for Content Type in HDCP1.4).
1136 * HDCP2.2 authentication protocol itself takes the "Content Type" as a
1137 * parameter, which is a input for the DP HDCP2.2 encryption algo.
1139 * In case of Type 0 content protection request, kernel driver can choose
1140 * either of HDCP spec versions 1.4 and 2.2. When HDCP2.2 is used for
1141 * "HDCP Type 0", a HDCP 2.2 capable repeater in the downstream can send
1142 * that content to a HDCP 1.4 authenticated HDCP sink (Type0 link).
1143 * But if the content is classified as "HDCP Type 1", above mentioned
1144 * HDCP 2.2 repeater wont send the content to the HDCP sink as it can't
1145 * authenticate the HDCP1.4 capable sink for "HDCP Type 1".
1147 * Please note userspace can be ignorant of the HDCP versions used by the
1148 * kernel driver to achieve the "HDCP Content Type".
1150 * At current scenario, classifying a content as Type 1 ensures that the
1151 * content will be displayed only through the HDCP2.2 encrypted link.
1153 * Note that the HDCP Content Type property is introduced at HDCP 2.2, and
1154 * defaults to type 0. It is only exposed by drivers supporting HDCP 2.2
1155 * (hence supporting Type 0 and Type 1). Based on how next versions of
1156 * HDCP specs are defined content Type could be used for higher versions
1159 * If content type is changed when "Content Protection" is not UNDESIRED,
1160 * then kernel will disable the HDCP and re-enable with new type in the
1161 * same atomic commit. And when "Content Protection" is ENABLED, it means
1162 * that link is HDCP authenticated and encrypted, for the transmission of
1163 * the Type of stream mentioned at "HDCP Content Type".
1165 * HDR_OUTPUT_METADATA:
1166 * Connector property to enable userspace to send HDR Metadata to
1167 * driver. This metadata is based on the composition and blending
1168 * policies decided by user, taking into account the hardware and
1169 * sink capabilities. The driver gets this metadata and creates a
1170 * Dynamic Range and Mastering Infoframe (DRM) in case of HDMI,
1171 * SDP packet (Non-audio INFOFRAME SDP v1.3) for DP. This is then
1172 * sent to sink. This notifies the sink of the upcoming frame's Color
1173 * Encoding and Luminance parameters.
1175 * Userspace first need to detect the HDR capabilities of sink by
1176 * reading and parsing the EDID. Details of HDR metadata for HDMI
1177 * are added in CTA 861.G spec. For DP , its defined in VESA DP
1178 * Standard v1.4. It needs to then get the metadata information
1179 * of the video/game/app content which are encoded in HDR (basically
1180 * using HDR transfer functions). With this information it needs to
1181 * decide on a blending policy and compose the relevant
1182 * layers/overlays into a common format. Once this blending is done,
1183 * userspace will be aware of the metadata of the composed frame to
1184 * be send to sink. It then uses this property to communicate this
1185 * metadata to driver which then make a Infoframe packet and sends
1186 * to sink based on the type of encoder connected.
1188 * Userspace will be responsible to do Tone mapping operation in case:
1189 * - Some layers are HDR and others are SDR
1190 * - HDR layers luminance is not same as sink
1192 * It will even need to do colorspace conversion and get all layers
1193 * to one common colorspace for blending. It can use either GL, Media
1194 * or display engine to get this done based on the capabilities of the
1195 * associated hardware.
1197 * Driver expects metadata to be put in &struct hdr_output_metadata
1198 * structure from userspace. This is received as blob and stored in
1199 * &drm_connector_state.hdr_output_metadata. It parses EDID and saves the
1200 * sink metadata in &struct hdr_sink_metadata, as
1201 * &drm_connector.hdr_sink_metadata. Driver uses
1202 * drm_hdmi_infoframe_set_hdr_metadata() helper to set the HDR metadata,
1203 * hdmi_drm_infoframe_pack() to pack the infoframe as per spec, in case of
1207 * This range property is used by userspace to limit the bit depth. When
1208 * used the driver would limit the bpc in accordance with the valid range
1209 * supported by the hardware and sink. Drivers to use the function
1210 * drm_connector_attach_max_bpc_property() to create and attach the
1211 * property to the connector during initialization.
1213 * Connectors also have one standardized atomic property:
1216 * Mode object ID of the &drm_crtc this connector should be connected to.
1218 * Connectors for LCD panels may also have one standardized property:
1220 * panel orientation:
1221 * On some devices the LCD panel is mounted in the casing in such a way
1222 * that the up/top side of the panel does not match with the top side of
1223 * the device. Userspace can use this property to check for this.
1224 * Note that input coordinates from touchscreens (input devices with
1225 * INPUT_PROP_DIRECT) will still map 1:1 to the actual LCD panel
1226 * coordinates, so if userspace rotates the picture to adjust for
1227 * the orientation it must also apply the same transformation to the
1228 * touchscreen input coordinates. This property is initialized by calling
1229 * drm_connector_set_panel_orientation() or
1230 * drm_connector_set_panel_orientation_with_quirk()
1233 * This property defines how a non-native mode is upscaled to the native
1234 * mode of an LCD panel:
1237 * No upscaling happens, scaling is left to the panel. Not all
1238 * drivers expose this mode.
1240 * The output is upscaled to the full resolution of the panel,
1241 * ignoring the aspect ratio.
1243 * No upscaling happens, the output is centered within the native
1244 * resolution the panel.
1246 * The output is upscaled to maximize either the width or height
1247 * while retaining the aspect ratio.
1249 * This property should be set up by calling
1250 * drm_connector_attach_scaling_mode_property(). Note that drivers
1251 * can also expose this property to external outputs, in which case they
1252 * must support "None", which should be the default (since external screens
1253 * have a built-in scaler).
1256 * This property is used by DVI-I, TVout and DisplayPort to indicate different
1257 * connector subtypes. Enum values more or less match with those from main
1259 * For DVI-I and TVout there is also a matching property "select subconnector"
1260 * allowing to switch between signal types.
1261 * DP subconnector corresponds to a downstream port.
1264 int drm_connector_create_standard_properties(struct drm_device *dev)
1266 struct drm_property *prop;
1268 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1269 DRM_MODE_PROP_IMMUTABLE,
1273 dev->mode_config.edid_property = prop;
1275 prop = drm_property_create_enum(dev, 0,
1276 "DPMS", drm_dpms_enum_list,
1277 ARRAY_SIZE(drm_dpms_enum_list));
1280 dev->mode_config.dpms_property = prop;
1282 prop = drm_property_create(dev,
1283 DRM_MODE_PROP_BLOB |
1284 DRM_MODE_PROP_IMMUTABLE,
1288 dev->mode_config.path_property = prop;
1290 prop = drm_property_create(dev,
1291 DRM_MODE_PROP_BLOB |
1292 DRM_MODE_PROP_IMMUTABLE,
1296 dev->mode_config.tile_property = prop;
1298 prop = drm_property_create_enum(dev, 0, "link-status",
1299 drm_link_status_enum_list,
1300 ARRAY_SIZE(drm_link_status_enum_list));
1303 dev->mode_config.link_status_property = prop;
1305 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE, "non-desktop");
1308 dev->mode_config.non_desktop_property = prop;
1310 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB,
1311 "HDR_OUTPUT_METADATA", 0);
1314 dev->mode_config.hdr_output_metadata_property = prop;
1320 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1323 * Called by a driver the first time a DVI-I connector is made.
1325 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1327 struct drm_property *dvi_i_selector;
1328 struct drm_property *dvi_i_subconnector;
1330 if (dev->mode_config.dvi_i_select_subconnector_property)
1334 drm_property_create_enum(dev, 0,
1335 "select subconnector",
1336 drm_dvi_i_select_enum_list,
1337 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1338 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1340 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1342 drm_dvi_i_subconnector_enum_list,
1343 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1344 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1348 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1351 * drm_connector_attach_dp_subconnector_property - create subconnector property for DP
1352 * @connector: drm_connector to attach property
1354 * Called by a driver when DP connector is created.
1356 void drm_connector_attach_dp_subconnector_property(struct drm_connector *connector)
1358 struct drm_mode_config *mode_config = &connector->dev->mode_config;
1360 if (!mode_config->dp_subconnector_property)
1361 mode_config->dp_subconnector_property =
1362 drm_property_create_enum(connector->dev,
1363 DRM_MODE_PROP_IMMUTABLE,
1365 drm_dp_subconnector_enum_list,
1366 ARRAY_SIZE(drm_dp_subconnector_enum_list));
1368 drm_object_attach_property(&connector->base,
1369 mode_config->dp_subconnector_property,
1370 DRM_MODE_SUBCONNECTOR_Unknown);
1372 EXPORT_SYMBOL(drm_connector_attach_dp_subconnector_property);
1375 * DOC: HDMI connector properties
1377 * content type (HDMI specific):
1378 * Indicates content type setting to be used in HDMI infoframes to indicate
1379 * content type for the external device, so that it adjusts its display
1380 * settings accordingly.
1382 * The value of this property can be one of the following:
1385 * Content type is unknown
1387 * Content type is graphics
1389 * Content type is photo
1391 * Content type is cinema
1393 * Content type is game
1395 * Drivers can set up this property by calling
1396 * drm_connector_attach_content_type_property(). Decoding to
1397 * infoframe values is done through drm_hdmi_avi_infoframe_content_type().
1401 * drm_connector_attach_content_type_property - attach content-type property
1402 * @connector: connector to attach content type property on.
1404 * Called by a driver the first time a HDMI connector is made.
1406 int drm_connector_attach_content_type_property(struct drm_connector *connector)
1408 if (!drm_mode_create_content_type_property(connector->dev))
1409 drm_object_attach_property(&connector->base,
1410 connector->dev->mode_config.content_type_property,
1411 DRM_MODE_CONTENT_TYPE_NO_DATA);
1414 EXPORT_SYMBOL(drm_connector_attach_content_type_property);
1418 * drm_hdmi_avi_infoframe_content_type() - fill the HDMI AVI infoframe
1419 * content type information, based
1420 * on correspondent DRM property.
1421 * @frame: HDMI AVI infoframe
1422 * @conn_state: DRM display connector state
1425 void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
1426 const struct drm_connector_state *conn_state)
1428 switch (conn_state->content_type) {
1429 case DRM_MODE_CONTENT_TYPE_GRAPHICS:
1430 frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1432 case DRM_MODE_CONTENT_TYPE_CINEMA:
1433 frame->content_type = HDMI_CONTENT_TYPE_CINEMA;
1435 case DRM_MODE_CONTENT_TYPE_GAME:
1436 frame->content_type = HDMI_CONTENT_TYPE_GAME;
1438 case DRM_MODE_CONTENT_TYPE_PHOTO:
1439 frame->content_type = HDMI_CONTENT_TYPE_PHOTO;
1442 /* Graphics is the default(0) */
1443 frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1446 frame->itc = conn_state->content_type != DRM_MODE_CONTENT_TYPE_NO_DATA;
1448 EXPORT_SYMBOL(drm_hdmi_avi_infoframe_content_type);
1451 * drm_mode_attach_tv_margin_properties - attach TV connector margin properties
1452 * @connector: DRM connector
1454 * Called by a driver when it needs to attach TV margin props to a connector.
1455 * Typically used on SDTV and HDMI connectors.
1457 void drm_connector_attach_tv_margin_properties(struct drm_connector *connector)
1459 struct drm_device *dev = connector->dev;
1461 drm_object_attach_property(&connector->base,
1462 dev->mode_config.tv_left_margin_property,
1464 drm_object_attach_property(&connector->base,
1465 dev->mode_config.tv_right_margin_property,
1467 drm_object_attach_property(&connector->base,
1468 dev->mode_config.tv_top_margin_property,
1470 drm_object_attach_property(&connector->base,
1471 dev->mode_config.tv_bottom_margin_property,
1474 EXPORT_SYMBOL(drm_connector_attach_tv_margin_properties);
1477 * drm_mode_create_tv_margin_properties - create TV connector margin properties
1480 * Called by a driver's HDMI connector initialization routine, this function
1481 * creates the TV margin properties for a given device. No need to call this
1482 * function for an SDTV connector, it's already called from
1483 * drm_mode_create_tv_properties().
1485 int drm_mode_create_tv_margin_properties(struct drm_device *dev)
1487 if (dev->mode_config.tv_left_margin_property)
1490 dev->mode_config.tv_left_margin_property =
1491 drm_property_create_range(dev, 0, "left margin", 0, 100);
1492 if (!dev->mode_config.tv_left_margin_property)
1495 dev->mode_config.tv_right_margin_property =
1496 drm_property_create_range(dev, 0, "right margin", 0, 100);
1497 if (!dev->mode_config.tv_right_margin_property)
1500 dev->mode_config.tv_top_margin_property =
1501 drm_property_create_range(dev, 0, "top margin", 0, 100);
1502 if (!dev->mode_config.tv_top_margin_property)
1505 dev->mode_config.tv_bottom_margin_property =
1506 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1507 if (!dev->mode_config.tv_bottom_margin_property)
1512 EXPORT_SYMBOL(drm_mode_create_tv_margin_properties);
1515 * drm_mode_create_tv_properties - create TV specific connector properties
1517 * @num_modes: number of different TV formats (modes) supported
1518 * @modes: array of pointers to strings containing name of each format
1520 * Called by a driver's TV initialization routine, this function creates
1521 * the TV specific connector properties for a given device. Caller is
1522 * responsible for allocating a list of format names and passing them to
1525 int drm_mode_create_tv_properties(struct drm_device *dev,
1526 unsigned int num_modes,
1527 const char * const modes[])
1529 struct drm_property *tv_selector;
1530 struct drm_property *tv_subconnector;
1533 if (dev->mode_config.tv_select_subconnector_property)
1537 * Basic connector properties
1539 tv_selector = drm_property_create_enum(dev, 0,
1540 "select subconnector",
1541 drm_tv_select_enum_list,
1542 ARRAY_SIZE(drm_tv_select_enum_list));
1546 dev->mode_config.tv_select_subconnector_property = tv_selector;
1549 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1551 drm_tv_subconnector_enum_list,
1552 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1553 if (!tv_subconnector)
1555 dev->mode_config.tv_subconnector_property = tv_subconnector;
1558 * Other, TV specific properties: margins & TV modes.
1560 if (drm_mode_create_tv_margin_properties(dev))
1563 dev->mode_config.tv_mode_property =
1564 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1566 if (!dev->mode_config.tv_mode_property)
1569 for (i = 0; i < num_modes; i++)
1570 drm_property_add_enum(dev->mode_config.tv_mode_property,
1573 dev->mode_config.tv_brightness_property =
1574 drm_property_create_range(dev, 0, "brightness", 0, 100);
1575 if (!dev->mode_config.tv_brightness_property)
1578 dev->mode_config.tv_contrast_property =
1579 drm_property_create_range(dev, 0, "contrast", 0, 100);
1580 if (!dev->mode_config.tv_contrast_property)
1583 dev->mode_config.tv_flicker_reduction_property =
1584 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1585 if (!dev->mode_config.tv_flicker_reduction_property)
1588 dev->mode_config.tv_overscan_property =
1589 drm_property_create_range(dev, 0, "overscan", 0, 100);
1590 if (!dev->mode_config.tv_overscan_property)
1593 dev->mode_config.tv_saturation_property =
1594 drm_property_create_range(dev, 0, "saturation", 0, 100);
1595 if (!dev->mode_config.tv_saturation_property)
1598 dev->mode_config.tv_hue_property =
1599 drm_property_create_range(dev, 0, "hue", 0, 100);
1600 if (!dev->mode_config.tv_hue_property)
1607 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1610 * drm_mode_create_scaling_mode_property - create scaling mode property
1613 * Called by a driver the first time it's needed, must be attached to desired
1616 * Atomic drivers should use drm_connector_attach_scaling_mode_property()
1617 * instead to correctly assign &drm_connector_state.picture_aspect_ratio
1618 * in the atomic state.
1620 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1622 struct drm_property *scaling_mode;
1624 if (dev->mode_config.scaling_mode_property)
1628 drm_property_create_enum(dev, 0, "scaling mode",
1629 drm_scaling_mode_enum_list,
1630 ARRAY_SIZE(drm_scaling_mode_enum_list));
1632 dev->mode_config.scaling_mode_property = scaling_mode;
1636 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1639 * DOC: Variable refresh properties
1641 * Variable refresh rate capable displays can dynamically adjust their
1642 * refresh rate by extending the duration of their vertical front porch
1643 * until page flip or timeout occurs. This can reduce or remove stuttering
1644 * and latency in scenarios where the page flip does not align with the
1647 * An example scenario would be an application flipping at a constant rate
1648 * of 48Hz on a 60Hz display. The page flip will frequently miss the vblank
1649 * interval and the same contents will be displayed twice. This can be
1650 * observed as stuttering for content with motion.
1652 * If variable refresh rate was active on a display that supported a
1653 * variable refresh range from 35Hz to 60Hz no stuttering would be observable
1654 * for the example scenario. The minimum supported variable refresh rate of
1655 * 35Hz is below the page flip frequency and the vertical front porch can
1656 * be extended until the page flip occurs. The vblank interval will be
1657 * directly aligned to the page flip rate.
1659 * Not all userspace content is suitable for use with variable refresh rate.
1660 * Large and frequent changes in vertical front porch duration may worsen
1661 * perceived stuttering for input sensitive applications.
1663 * Panel brightness will also vary with vertical front porch duration. Some
1664 * panels may have noticeable differences in brightness between the minimum
1665 * vertical front porch duration and the maximum vertical front porch duration.
1666 * Large and frequent changes in vertical front porch duration may produce
1667 * observable flickering for such panels.
1669 * Userspace control for variable refresh rate is supported via properties
1670 * on the &drm_connector and &drm_crtc objects.
1673 * Optional &drm_connector boolean property that drivers should attach
1674 * with drm_connector_attach_vrr_capable_property() on connectors that
1675 * could support variable refresh rates. Drivers should update the
1676 * property value by calling drm_connector_set_vrr_capable_property().
1678 * Absence of the property should indicate absence of support.
1681 * Default &drm_crtc boolean property that notifies the driver that the
1682 * content on the CRTC is suitable for variable refresh rate presentation.
1683 * The driver will take this property as a hint to enable variable
1684 * refresh rate support if the receiver supports it, ie. if the
1685 * "vrr_capable" property is true on the &drm_connector object. The
1686 * vertical front porch duration will be extended until page-flip or
1687 * timeout when enabled.
1689 * The minimum vertical front porch duration is defined as the vertical
1690 * front porch duration for the current mode.
1692 * The maximum vertical front porch duration is greater than or equal to
1693 * the minimum vertical front porch duration. The duration is derived
1694 * from the minimum supported variable refresh rate for the connector.
1696 * The driver may place further restrictions within these minimum
1697 * and maximum bounds.
1701 * drm_connector_attach_vrr_capable_property - creates the
1702 * vrr_capable property
1703 * @connector: connector to create the vrr_capable property on.
1705 * This is used by atomic drivers to add support for querying
1706 * variable refresh rate capability for a connector.
1709 * Zero on success, negative errno on failure.
1711 int drm_connector_attach_vrr_capable_property(
1712 struct drm_connector *connector)
1714 struct drm_device *dev = connector->dev;
1715 struct drm_property *prop;
1717 if (!connector->vrr_capable_property) {
1718 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE,
1723 connector->vrr_capable_property = prop;
1724 drm_object_attach_property(&connector->base, prop, 0);
1729 EXPORT_SYMBOL(drm_connector_attach_vrr_capable_property);
1732 * drm_connector_attach_scaling_mode_property - attach atomic scaling mode property
1733 * @connector: connector to attach scaling mode property on.
1734 * @scaling_mode_mask: or'ed mask of BIT(%DRM_MODE_SCALE_\*).
1736 * This is used to add support for scaling mode to atomic drivers.
1737 * The scaling mode will be set to &drm_connector_state.picture_aspect_ratio
1738 * and can be used from &drm_connector_helper_funcs->atomic_check for validation.
1740 * This is the atomic version of drm_mode_create_scaling_mode_property().
1743 * Zero on success, negative errno on failure.
1745 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1746 u32 scaling_mode_mask)
1748 struct drm_device *dev = connector->dev;
1749 struct drm_property *scaling_mode_property;
1751 const unsigned valid_scaling_mode_mask =
1752 (1U << ARRAY_SIZE(drm_scaling_mode_enum_list)) - 1;
1754 if (WARN_ON(hweight32(scaling_mode_mask) < 2 ||
1755 scaling_mode_mask & ~valid_scaling_mode_mask))
1758 scaling_mode_property =
1759 drm_property_create(dev, DRM_MODE_PROP_ENUM, "scaling mode",
1760 hweight32(scaling_mode_mask));
1762 if (!scaling_mode_property)
1765 for (i = 0; i < ARRAY_SIZE(drm_scaling_mode_enum_list); i++) {
1768 if (!(BIT(i) & scaling_mode_mask))
1771 ret = drm_property_add_enum(scaling_mode_property,
1772 drm_scaling_mode_enum_list[i].type,
1773 drm_scaling_mode_enum_list[i].name);
1776 drm_property_destroy(dev, scaling_mode_property);
1782 drm_object_attach_property(&connector->base,
1783 scaling_mode_property, 0);
1785 connector->scaling_mode_property = scaling_mode_property;
1789 EXPORT_SYMBOL(drm_connector_attach_scaling_mode_property);
1792 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1795 * Called by a driver the first time it's needed, must be attached to desired
1799 * Zero on success, negative errno on failure.
1801 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1803 if (dev->mode_config.aspect_ratio_property)
1806 dev->mode_config.aspect_ratio_property =
1807 drm_property_create_enum(dev, 0, "aspect ratio",
1808 drm_aspect_ratio_enum_list,
1809 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1811 if (dev->mode_config.aspect_ratio_property == NULL)
1816 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1819 * DOC: standard connector properties
1822 * This property helps select a suitable colorspace based on the sink
1823 * capability. Modern sink devices support wider gamut like BT2020.
1824 * This helps switch to BT2020 mode if the BT2020 encoded video stream
1825 * is being played by the user, same for any other colorspace. Thereby
1826 * giving a good visual experience to users.
1828 * The expectation from userspace is that it should parse the EDID
1829 * and get supported colorspaces. Use this property and switch to the
1830 * one supported. Sink supported colorspaces should be retrieved by
1831 * userspace from EDID and driver will not explicitly expose them.
1833 * Basically the expectation from userspace is:
1834 * - Set up CRTC DEGAMMA/CTM/GAMMA to convert to some sink
1836 * - Set this new property to let the sink know what it
1837 * converted the CRTC output to.
1838 * - This property is just to inform sink what colorspace
1839 * source is trying to drive.
1841 * Because between HDMI and DP have different colorspaces,
1842 * drm_mode_create_hdmi_colorspace_property() is used for HDMI connector and
1843 * drm_mode_create_dp_colorspace_property() is used for DP connector.
1847 * drm_mode_create_hdmi_colorspace_property - create hdmi colorspace property
1848 * @connector: connector to create the Colorspace property on.
1850 * Called by a driver the first time it's needed, must be attached to desired
1854 * Zero on success, negative errno on failure.
1856 int drm_mode_create_hdmi_colorspace_property(struct drm_connector *connector)
1858 struct drm_device *dev = connector->dev;
1860 if (connector->colorspace_property)
1863 connector->colorspace_property =
1864 drm_property_create_enum(dev, DRM_MODE_PROP_ENUM, "Colorspace",
1866 ARRAY_SIZE(hdmi_colorspaces));
1868 if (!connector->colorspace_property)
1873 EXPORT_SYMBOL(drm_mode_create_hdmi_colorspace_property);
1876 * drm_mode_create_dp_colorspace_property - create dp colorspace property
1877 * @connector: connector to create the Colorspace property on.
1879 * Called by a driver the first time it's needed, must be attached to desired
1883 * Zero on success, negative errno on failure.
1885 int drm_mode_create_dp_colorspace_property(struct drm_connector *connector)
1887 struct drm_device *dev = connector->dev;
1889 if (connector->colorspace_property)
1892 connector->colorspace_property =
1893 drm_property_create_enum(dev, DRM_MODE_PROP_ENUM, "Colorspace",
1895 ARRAY_SIZE(dp_colorspaces));
1897 if (!connector->colorspace_property)
1902 EXPORT_SYMBOL(drm_mode_create_dp_colorspace_property);
1905 * drm_mode_create_content_type_property - create content type property
1908 * Called by a driver the first time it's needed, must be attached to desired
1912 * Zero on success, negative errno on failure.
1914 int drm_mode_create_content_type_property(struct drm_device *dev)
1916 if (dev->mode_config.content_type_property)
1919 dev->mode_config.content_type_property =
1920 drm_property_create_enum(dev, 0, "content type",
1921 drm_content_type_enum_list,
1922 ARRAY_SIZE(drm_content_type_enum_list));
1924 if (dev->mode_config.content_type_property == NULL)
1929 EXPORT_SYMBOL(drm_mode_create_content_type_property);
1932 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1935 * Create the suggested x/y offset property for connectors.
1937 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1939 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1942 dev->mode_config.suggested_x_property =
1943 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1945 dev->mode_config.suggested_y_property =
1946 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1948 if (dev->mode_config.suggested_x_property == NULL ||
1949 dev->mode_config.suggested_y_property == NULL)
1953 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1956 * drm_connector_set_path_property - set tile property on connector
1957 * @connector: connector to set property on.
1958 * @path: path to use for property; must not be NULL.
1960 * This creates a property to expose to userspace to specify a
1961 * connector path. This is mainly used for DisplayPort MST where
1962 * connectors have a topology and we want to allow userspace to give
1963 * them more meaningful names.
1966 * Zero on success, negative errno on failure.
1968 int drm_connector_set_path_property(struct drm_connector *connector,
1971 struct drm_device *dev = connector->dev;
1974 ret = drm_property_replace_global_blob(dev,
1975 &connector->path_blob_ptr,
1979 dev->mode_config.path_property);
1982 EXPORT_SYMBOL(drm_connector_set_path_property);
1985 * drm_connector_set_tile_property - set tile property on connector
1986 * @connector: connector to set property on.
1988 * This looks up the tile information for a connector, and creates a
1989 * property for userspace to parse if it exists. The property is of
1990 * the form of 8 integers using ':' as a separator.
1991 * This is used for dual port tiled displays with DisplayPort SST
1992 * or DisplayPort MST connectors.
1995 * Zero on success, errno on failure.
1997 int drm_connector_set_tile_property(struct drm_connector *connector)
1999 struct drm_device *dev = connector->dev;
2003 if (!connector->has_tile) {
2004 ret = drm_property_replace_global_blob(dev,
2005 &connector->tile_blob_ptr,
2009 dev->mode_config.tile_property);
2013 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
2014 connector->tile_group->id, connector->tile_is_single_monitor,
2015 connector->num_h_tile, connector->num_v_tile,
2016 connector->tile_h_loc, connector->tile_v_loc,
2017 connector->tile_h_size, connector->tile_v_size);
2019 ret = drm_property_replace_global_blob(dev,
2020 &connector->tile_blob_ptr,
2024 dev->mode_config.tile_property);
2027 EXPORT_SYMBOL(drm_connector_set_tile_property);
2030 * drm_connector_update_edid_property - update the edid property of a connector
2031 * @connector: drm connector
2032 * @edid: new value of the edid property
2034 * This function creates a new blob modeset object and assigns its id to the
2035 * connector's edid property.
2036 * Since we also parse tile information from EDID's displayID block, we also
2037 * set the connector's tile property here. See drm_connector_set_tile_property()
2041 * Zero on success, negative errno on failure.
2043 int drm_connector_update_edid_property(struct drm_connector *connector,
2044 const struct edid *edid)
2046 struct drm_device *dev = connector->dev;
2049 const struct edid *old_edid;
2051 /* ignore requests to set edid when overridden */
2052 if (connector->override_edid)
2056 size = EDID_LENGTH * (1 + edid->extensions);
2058 /* Set the display info, using edid if available, otherwise
2059 * resetting the values to defaults. This duplicates the work
2060 * done in drm_add_edid_modes, but that function is not
2061 * consistently called before this one in all drivers and the
2062 * computation is cheap enough that it seems better to
2063 * duplicate it rather than attempt to ensure some arbitrary
2064 * ordering of calls.
2067 drm_add_display_info(connector, edid);
2069 drm_reset_display_info(connector);
2071 drm_update_tile_info(connector, edid);
2073 if (connector->edid_blob_ptr) {
2074 old_edid = (const struct edid *)connector->edid_blob_ptr->data;
2076 if (!drm_edid_are_equal(edid, old_edid)) {
2077 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] Edid was changed.\n",
2078 connector->base.id, connector->name);
2080 connector->epoch_counter += 1;
2081 DRM_DEBUG_KMS("Updating change counter to %llu\n",
2082 connector->epoch_counter);
2087 drm_object_property_set_value(&connector->base,
2088 dev->mode_config.non_desktop_property,
2089 connector->display_info.non_desktop);
2091 ret = drm_property_replace_global_blob(dev,
2092 &connector->edid_blob_ptr,
2096 dev->mode_config.edid_property);
2099 return drm_connector_set_tile_property(connector);
2101 EXPORT_SYMBOL(drm_connector_update_edid_property);
2104 * drm_connector_set_link_status_property - Set link status property of a connector
2105 * @connector: drm connector
2106 * @link_status: new value of link status property (0: Good, 1: Bad)
2108 * In usual working scenario, this link status property will always be set to
2109 * "GOOD". If something fails during or after a mode set, the kernel driver
2110 * may set this link status property to "BAD". The caller then needs to send a
2111 * hotplug uevent for userspace to re-check the valid modes through
2112 * GET_CONNECTOR_IOCTL and retry modeset.
2114 * Note: Drivers cannot rely on userspace to support this property and
2115 * issue a modeset. As such, they may choose to handle issues (like
2116 * re-training a link) without userspace's intervention.
2118 * The reason for adding this property is to handle link training failures, but
2119 * it is not limited to DP or link training. For example, if we implement
2120 * asynchronous setcrtc, this property can be used to report any failures in that.
2122 void drm_connector_set_link_status_property(struct drm_connector *connector,
2123 uint64_t link_status)
2125 struct drm_device *dev = connector->dev;
2127 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2128 connector->state->link_status = link_status;
2129 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2131 EXPORT_SYMBOL(drm_connector_set_link_status_property);
2134 * drm_connector_attach_max_bpc_property - attach "max bpc" property
2135 * @connector: connector to attach max bpc property on.
2136 * @min: The minimum bit depth supported by the connector.
2137 * @max: The maximum bit depth supported by the connector.
2139 * This is used to add support for limiting the bit depth on a connector.
2142 * Zero on success, negative errno on failure.
2144 int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
2147 struct drm_device *dev = connector->dev;
2148 struct drm_property *prop;
2150 prop = connector->max_bpc_property;
2152 prop = drm_property_create_range(dev, 0, "max bpc", min, max);
2156 connector->max_bpc_property = prop;
2159 drm_object_attach_property(&connector->base, prop, max);
2160 connector->state->max_requested_bpc = max;
2161 connector->state->max_bpc = max;
2165 EXPORT_SYMBOL(drm_connector_attach_max_bpc_property);
2168 * drm_connector_set_vrr_capable_property - sets the variable refresh rate
2169 * capable property for a connector
2170 * @connector: drm connector
2171 * @capable: True if the connector is variable refresh rate capable
2173 * Should be used by atomic drivers to update the indicated support for
2174 * variable refresh rate over a connector.
2176 void drm_connector_set_vrr_capable_property(
2177 struct drm_connector *connector, bool capable)
2179 if (!connector->vrr_capable_property)
2182 drm_object_property_set_value(&connector->base,
2183 connector->vrr_capable_property,
2186 EXPORT_SYMBOL(drm_connector_set_vrr_capable_property);
2189 * drm_connector_set_panel_orientation - sets the connector's panel_orientation
2190 * @connector: connector for which to set the panel-orientation property.
2191 * @panel_orientation: drm_panel_orientation value to set
2193 * This function sets the connector's panel_orientation and attaches
2194 * a "panel orientation" property to the connector.
2196 * Calling this function on a connector where the panel_orientation has
2197 * already been set is a no-op (e.g. the orientation has been overridden with
2198 * a kernel commandline option).
2200 * It is allowed to call this function with a panel_orientation of
2201 * DRM_MODE_PANEL_ORIENTATION_UNKNOWN, in which case it is a no-op.
2204 * Zero on success, negative errno on failure.
2206 int drm_connector_set_panel_orientation(
2207 struct drm_connector *connector,
2208 enum drm_panel_orientation panel_orientation)
2210 struct drm_device *dev = connector->dev;
2211 struct drm_display_info *info = &connector->display_info;
2212 struct drm_property *prop;
2215 if (info->panel_orientation != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2218 /* Don't attach the property if the orientation is unknown */
2219 if (panel_orientation == DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2222 info->panel_orientation = panel_orientation;
2224 prop = dev->mode_config.panel_orientation_property;
2226 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
2227 "panel orientation",
2228 drm_panel_orientation_enum_list,
2229 ARRAY_SIZE(drm_panel_orientation_enum_list));
2233 dev->mode_config.panel_orientation_property = prop;
2236 drm_object_attach_property(&connector->base, prop,
2237 info->panel_orientation);
2240 EXPORT_SYMBOL(drm_connector_set_panel_orientation);
2243 * drm_connector_set_panel_orientation_with_quirk -
2244 * set the connector's panel_orientation after checking for quirks
2245 * @connector: connector for which to init the panel-orientation property.
2246 * @panel_orientation: drm_panel_orientation value to set
2247 * @width: width in pixels of the panel, used for panel quirk detection
2248 * @height: height in pixels of the panel, used for panel quirk detection
2250 * Like drm_connector_set_panel_orientation(), but with a check for platform
2251 * specific (e.g. DMI based) quirks overriding the passed in panel_orientation.
2254 * Zero on success, negative errno on failure.
2256 int drm_connector_set_panel_orientation_with_quirk(
2257 struct drm_connector *connector,
2258 enum drm_panel_orientation panel_orientation,
2259 int width, int height)
2261 int orientation_quirk;
2263 orientation_quirk = drm_get_panel_orientation_quirk(width, height);
2264 if (orientation_quirk != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2265 panel_orientation = orientation_quirk;
2267 return drm_connector_set_panel_orientation(connector,
2270 EXPORT_SYMBOL(drm_connector_set_panel_orientation_with_quirk);
2272 int drm_connector_set_obj_prop(struct drm_mode_object *obj,
2273 struct drm_property *property,
2277 struct drm_connector *connector = obj_to_connector(obj);
2279 /* Do DPMS ourselves */
2280 if (property == connector->dev->mode_config.dpms_property) {
2281 ret = (*connector->funcs->dpms)(connector, (int)value);
2282 } else if (connector->funcs->set_property)
2283 ret = connector->funcs->set_property(connector, property, value);
2286 drm_object_property_set_value(&connector->base, property, value);
2290 int drm_connector_property_set_ioctl(struct drm_device *dev,
2291 void *data, struct drm_file *file_priv)
2293 struct drm_mode_connector_set_property *conn_set_prop = data;
2294 struct drm_mode_obj_set_property obj_set_prop = {
2295 .value = conn_set_prop->value,
2296 .prop_id = conn_set_prop->prop_id,
2297 .obj_id = conn_set_prop->connector_id,
2298 .obj_type = DRM_MODE_OBJECT_CONNECTOR
2301 /* It does all the locking and checking we need */
2302 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
2305 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
2307 /* For atomic drivers only state objects are synchronously updated and
2308 * protected by modeset locks, so check those first. */
2309 if (connector->state)
2310 return connector->state->best_encoder;
2311 return connector->encoder;
2315 drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
2316 const struct list_head *modes,
2317 const struct drm_file *file_priv)
2320 * If user-space hasn't configured the driver to expose the stereo 3D
2321 * modes, don't expose them.
2323 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
2326 * If user-space hasn't configured the driver to expose the modes
2327 * with aspect-ratio, don't expose them. However if such a mode
2328 * is unique, let it be exposed, but reset the aspect-ratio flags
2329 * while preparing the list of user-modes.
2331 if (!file_priv->aspect_ratio_allowed) {
2332 const struct drm_display_mode *mode_itr;
2334 list_for_each_entry(mode_itr, modes, head) {
2335 if (mode_itr->expose_to_userspace &&
2336 drm_mode_match(mode_itr, mode,
2337 DRM_MODE_MATCH_TIMINGS |
2338 DRM_MODE_MATCH_CLOCK |
2339 DRM_MODE_MATCH_FLAGS |
2340 DRM_MODE_MATCH_3D_FLAGS))
2348 int drm_mode_getconnector(struct drm_device *dev, void *data,
2349 struct drm_file *file_priv)
2351 struct drm_mode_get_connector *out_resp = data;
2352 struct drm_connector *connector;
2353 struct drm_encoder *encoder;
2354 struct drm_display_mode *mode;
2356 int encoders_count = 0;
2359 struct drm_mode_modeinfo u_mode;
2360 struct drm_mode_modeinfo __user *mode_ptr;
2361 uint32_t __user *encoder_ptr;
2363 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2366 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2368 connector = drm_connector_lookup(dev, file_priv, out_resp->connector_id);
2372 encoders_count = hweight32(connector->possible_encoders);
2374 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2376 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2378 drm_connector_for_each_possible_encoder(connector, encoder) {
2379 if (put_user(encoder->base.id, encoder_ptr + copied)) {
2386 out_resp->count_encoders = encoders_count;
2388 out_resp->connector_id = connector->base.id;
2389 out_resp->connector_type = connector->connector_type;
2390 out_resp->connector_type_id = connector->connector_type_id;
2392 mutex_lock(&dev->mode_config.mutex);
2393 if (out_resp->count_modes == 0) {
2394 connector->funcs->fill_modes(connector,
2395 dev->mode_config.max_width,
2396 dev->mode_config.max_height);
2399 out_resp->mm_width = connector->display_info.width_mm;
2400 out_resp->mm_height = connector->display_info.height_mm;
2401 out_resp->subpixel = connector->display_info.subpixel_order;
2402 out_resp->connection = connector->status;
2404 /* delayed so we get modes regardless of pre-fill_modes state */
2405 list_for_each_entry(mode, &connector->modes, head) {
2406 WARN_ON(mode->expose_to_userspace);
2408 if (drm_mode_expose_to_userspace(mode, &connector->modes,
2410 mode->expose_to_userspace = true;
2416 * This ioctl is called twice, once to determine how much space is
2417 * needed, and the 2nd time to fill it.
2419 if ((out_resp->count_modes >= mode_count) && mode_count) {
2421 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2422 list_for_each_entry(mode, &connector->modes, head) {
2423 if (!mode->expose_to_userspace)
2426 /* Clear the tag for the next time around */
2427 mode->expose_to_userspace = false;
2429 drm_mode_convert_to_umode(&u_mode, mode);
2431 * Reset aspect ratio flags of user-mode, if modes with
2432 * aspect-ratio are not supported.
2434 if (!file_priv->aspect_ratio_allowed)
2435 u_mode.flags &= ~DRM_MODE_FLAG_PIC_AR_MASK;
2436 if (copy_to_user(mode_ptr + copied,
2437 &u_mode, sizeof(u_mode))) {
2441 * Clear the tag for the rest of
2442 * the modes for the next time around.
2444 list_for_each_entry_continue(mode, &connector->modes, head)
2445 mode->expose_to_userspace = false;
2447 mutex_unlock(&dev->mode_config.mutex);
2454 /* Clear the tag for the next time around */
2455 list_for_each_entry(mode, &connector->modes, head)
2456 mode->expose_to_userspace = false;
2459 out_resp->count_modes = mode_count;
2460 mutex_unlock(&dev->mode_config.mutex);
2462 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2463 encoder = drm_connector_get_encoder(connector);
2465 out_resp->encoder_id = encoder->base.id;
2467 out_resp->encoder_id = 0;
2469 /* Only grab properties after probing, to make sure EDID and other
2470 * properties reflect the latest status. */
2471 ret = drm_mode_object_get_properties(&connector->base, file_priv->atomic,
2472 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
2473 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
2474 &out_resp->count_props);
2475 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2478 drm_connector_put(connector);
2484 * drm_connector_find_by_fwnode - Find a connector based on the associated fwnode
2485 * @fwnode: fwnode for which to find the matching drm_connector
2487 * This functions looks up a drm_connector based on its associated fwnode. When
2488 * a connector is found a reference to the connector is returned. The caller must
2489 * call drm_connector_put() to release this reference when it is done with the
2492 * Returns: A reference to the found connector or an ERR_PTR().
2494 struct drm_connector *drm_connector_find_by_fwnode(struct fwnode_handle *fwnode)
2496 struct drm_connector *connector, *found = ERR_PTR(-ENODEV);
2499 return ERR_PTR(-ENODEV);
2501 mutex_lock(&connector_list_lock);
2503 list_for_each_entry(connector, &connector_list, global_connector_list_entry) {
2504 if (connector->fwnode == fwnode ||
2505 (connector->fwnode && connector->fwnode->secondary == fwnode)) {
2506 drm_connector_get(connector);
2512 mutex_unlock(&connector_list_lock);
2518 * drm_connector_oob_hotplug_event - Report out-of-band hotplug event to connector
2519 * @connector: connector to report the event on
2521 * On some hardware a hotplug event notification may come from outside the display
2522 * driver / device. An example of this is some USB Type-C setups where the hardware
2523 * muxes the DisplayPort data and aux-lines but does not pass the altmode HPD
2524 * status bit to the GPU's DP HPD pin.
2526 * This function can be used to report these out-of-band events after obtaining
2527 * a drm_connector reference through calling drm_connector_find_by_fwnode().
2529 void drm_connector_oob_hotplug_event(struct fwnode_handle *connector_fwnode)
2531 struct drm_connector *connector;
2533 connector = drm_connector_find_by_fwnode(connector_fwnode);
2534 if (IS_ERR(connector))
2537 if (connector->funcs->oob_hotplug_event)
2538 connector->funcs->oob_hotplug_event(connector);
2540 drm_connector_put(connector);
2542 EXPORT_SYMBOL(drm_connector_oob_hotplug_event);
2548 * Tile groups are used to represent tiled monitors with a unique integer
2549 * identifier. Tiled monitors using DisplayID v1.3 have a unique 8-byte handle,
2550 * we store this in a tile group, so we have a common identifier for all tiles
2551 * in a monitor group. The property is called "TILE". Drivers can manage tile
2552 * groups using drm_mode_create_tile_group(), drm_mode_put_tile_group() and
2553 * drm_mode_get_tile_group(). But this is only needed for internal panels where
2554 * the tile group information is exposed through a non-standard way.
2557 static void drm_tile_group_free(struct kref *kref)
2559 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
2560 struct drm_device *dev = tg->dev;
2562 mutex_lock(&dev->mode_config.idr_mutex);
2563 idr_remove(&dev->mode_config.tile_idr, tg->id);
2564 mutex_unlock(&dev->mode_config.idr_mutex);
2569 * drm_mode_put_tile_group - drop a reference to a tile group.
2571 * @tg: tile group to drop reference to.
2573 * drop reference to tile group and free if 0.
2575 void drm_mode_put_tile_group(struct drm_device *dev,
2576 struct drm_tile_group *tg)
2578 kref_put(&tg->refcount, drm_tile_group_free);
2580 EXPORT_SYMBOL(drm_mode_put_tile_group);
2583 * drm_mode_get_tile_group - get a reference to an existing tile group
2585 * @topology: 8-bytes unique per monitor.
2587 * Use the unique bytes to get a reference to an existing tile group.
2590 * tile group or NULL if not found.
2592 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
2593 const char topology[8])
2595 struct drm_tile_group *tg;
2598 mutex_lock(&dev->mode_config.idr_mutex);
2599 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
2600 if (!memcmp(tg->group_data, topology, 8)) {
2601 if (!kref_get_unless_zero(&tg->refcount))
2603 mutex_unlock(&dev->mode_config.idr_mutex);
2607 mutex_unlock(&dev->mode_config.idr_mutex);
2610 EXPORT_SYMBOL(drm_mode_get_tile_group);
2613 * drm_mode_create_tile_group - create a tile group from a displayid description
2615 * @topology: 8-bytes unique per monitor.
2617 * Create a tile group for the unique monitor, and get a unique
2618 * identifier for the tile group.
2621 * new tile group or NULL.
2623 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
2624 const char topology[8])
2626 struct drm_tile_group *tg;
2629 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
2633 kref_init(&tg->refcount);
2634 memcpy(tg->group_data, topology, 8);
2637 mutex_lock(&dev->mode_config.idr_mutex);
2638 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
2646 mutex_unlock(&dev->mode_config.idr_mutex);
2649 EXPORT_SYMBOL(drm_mode_create_tile_group);