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_auth.h>
24 #include <drm/drm_connector.h>
25 #include <drm/drm_drv.h>
26 #include <drm/drm_edid.h>
27 #include <drm/drm_encoder.h>
28 #include <drm/drm_file.h>
29 #include <drm/drm_managed.h>
30 #include <drm/drm_panel.h>
31 #include <drm/drm_print.h>
32 #include <drm/drm_privacy_screen_consumer.h>
33 #include <drm/drm_sysfs.h>
34 #include <drm/drm_utils.h>
37 #include <linux/property.h>
38 #include <linux/uaccess.h>
40 #include <video/cmdline.h>
42 #include "drm_crtc_internal.h"
43 #include "drm_internal.h"
48 * In DRM connectors are the general abstraction for display sinks, and include
49 * also fixed panels or anything else that can display pixels in some form. As
50 * opposed to all other KMS objects representing hardware (like CRTC, encoder or
51 * plane abstractions) connectors can be hotplugged and unplugged at runtime.
52 * Hence they are reference-counted using drm_connector_get() and
53 * drm_connector_put().
55 * KMS driver must create, initialize, register and attach at a &struct
56 * drm_connector for each such sink. The instance is created as other KMS
57 * objects and initialized by setting the following fields. The connector is
58 * initialized with a call to drm_connector_init() with a pointer to the
59 * &struct drm_connector_funcs and a connector type, and then exposed to
60 * userspace with a call to drm_connector_register().
62 * Connectors must be attached to an encoder to be used. For devices that map
63 * connectors to encoders 1:1, the connector should be attached at
64 * initialization time with a call to drm_connector_attach_encoder(). The
65 * driver must also set the &drm_connector.encoder field to point to the
68 * For connectors which are not fixed (like built-in panels) the driver needs to
69 * support hotplug notifications. The simplest way to do that is by using the
70 * probe helpers, see drm_kms_helper_poll_init() for connectors which don't have
71 * hardware support for hotplug interrupts. Connectors with hardware hotplug
72 * support can instead use e.g. drm_helper_hpd_irq_event().
76 * Global connector list for drm_connector_find_by_fwnode().
77 * Note drm_connector_[un]register() first take connector->lock and then
78 * take the connector_list_lock.
80 static DEFINE_MUTEX(connector_list_lock);
81 static LIST_HEAD(connector_list);
83 struct drm_conn_prop_enum_list {
91 * Connector and encoder types.
93 static struct drm_conn_prop_enum_list drm_connector_enum_list[] = {
94 { DRM_MODE_CONNECTOR_Unknown, "Unknown" },
95 { DRM_MODE_CONNECTOR_VGA, "VGA" },
96 { DRM_MODE_CONNECTOR_DVII, "DVI-I" },
97 { DRM_MODE_CONNECTOR_DVID, "DVI-D" },
98 { DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
99 { DRM_MODE_CONNECTOR_Composite, "Composite" },
100 { DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
101 { DRM_MODE_CONNECTOR_LVDS, "LVDS" },
102 { DRM_MODE_CONNECTOR_Component, "Component" },
103 { DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
104 { DRM_MODE_CONNECTOR_DisplayPort, "DP" },
105 { DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
106 { DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
107 { DRM_MODE_CONNECTOR_TV, "TV" },
108 { DRM_MODE_CONNECTOR_eDP, "eDP" },
109 { DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
110 { DRM_MODE_CONNECTOR_DSI, "DSI" },
111 { DRM_MODE_CONNECTOR_DPI, "DPI" },
112 { DRM_MODE_CONNECTOR_WRITEBACK, "Writeback" },
113 { DRM_MODE_CONNECTOR_SPI, "SPI" },
114 { DRM_MODE_CONNECTOR_USB, "USB" },
117 #define MAX_DT_NODE_NAME_LEN 20
118 #define DT_DRM_NODE_PREFIX "drm-"
120 static void drm_connector_get_of_name(int type, char *node_name, int length)
124 strcpy(node_name, DT_DRM_NODE_PREFIX);
127 node_name[i + strlen(DT_DRM_NODE_PREFIX)] =
128 tolower(drm_connector_enum_list[type].name[i]);
130 } while (drm_connector_enum_list[type].name[i++] &&
133 node_name[length - 1] = '\0';
136 void drm_connector_ida_init(void)
139 char node_name[MAX_DT_NODE_NAME_LEN];
141 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++) {
142 ida_init(&drm_connector_enum_list[i].ida);
144 drm_connector_get_of_name(i, node_name, MAX_DT_NODE_NAME_LEN);
146 id = of_alias_get_highest_id(node_name);
148 drm_connector_enum_list[i].first_dyn_num = id + 1;
150 drm_connector_enum_list[i].first_dyn_num = 1;
154 void drm_connector_ida_destroy(void)
158 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
159 ida_destroy(&drm_connector_enum_list[i].ida);
163 * drm_get_connector_type_name - return a string for connector type
164 * @type: The connector type (DRM_MODE_CONNECTOR_*)
166 * Returns: the name of the connector type, or NULL if the type is not valid.
168 const char *drm_get_connector_type_name(unsigned int type)
170 if (type < ARRAY_SIZE(drm_connector_enum_list))
171 return drm_connector_enum_list[type].name;
175 EXPORT_SYMBOL(drm_get_connector_type_name);
178 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
179 * @connector: connector to query
181 * The kernel supports per-connector configuration of its consoles through
182 * use of the video= parameter. This function parses that option and
183 * extracts the user's specified mode (or enable/disable status) for a
184 * particular connector. This is typically only used during the early fbdev
187 static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
189 struct drm_cmdline_mode *mode = &connector->cmdline_mode;
192 option = video_get_options(connector->name);
196 if (!drm_mode_parse_command_line_for_connector(option,
202 DRM_INFO("forcing %s connector %s\n", connector->name,
203 drm_get_connector_force_name(mode->force));
204 connector->force = mode->force;
207 if (mode->panel_orientation != DRM_MODE_PANEL_ORIENTATION_UNKNOWN) {
208 DRM_INFO("cmdline forces connector %s panel_orientation to %d\n",
209 connector->name, mode->panel_orientation);
210 drm_connector_set_panel_orientation(connector,
211 mode->panel_orientation);
214 DRM_DEBUG_KMS("cmdline mode for connector %s %s %dx%d@%dHz%s%s%s\n",
215 connector->name, mode->name,
216 mode->xres, mode->yres,
217 mode->refresh_specified ? mode->refresh : 60,
218 mode->rb ? " reduced blanking" : "",
219 mode->margins ? " with margins" : "",
220 mode->interlace ? " interlaced" : "");
223 static void drm_connector_free(struct kref *kref)
225 struct drm_connector *connector =
226 container_of(kref, struct drm_connector, base.refcount);
227 struct drm_device *dev = connector->dev;
229 drm_mode_object_unregister(dev, &connector->base);
230 connector->funcs->destroy(connector);
233 void drm_connector_free_work_fn(struct work_struct *work)
235 struct drm_connector *connector, *n;
236 struct drm_device *dev =
237 container_of(work, struct drm_device, mode_config.connector_free_work);
238 struct drm_mode_config *config = &dev->mode_config;
240 struct llist_node *freed;
242 spin_lock_irqsave(&config->connector_list_lock, flags);
243 freed = llist_del_all(&config->connector_free_list);
244 spin_unlock_irqrestore(&config->connector_list_lock, flags);
246 llist_for_each_entry_safe(connector, n, freed, free_node) {
247 drm_mode_object_unregister(dev, &connector->base);
248 connector->funcs->destroy(connector);
252 static int __drm_connector_init(struct drm_device *dev,
253 struct drm_connector *connector,
254 const struct drm_connector_funcs *funcs,
256 struct i2c_adapter *ddc)
258 struct drm_mode_config *config = &dev->mode_config;
259 char node_name[MAX_DT_NODE_NAME_LEN];
262 struct ida *connector_ida =
263 &drm_connector_enum_list[connector_type].ida;
265 WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
266 (!funcs->atomic_destroy_state ||
267 !funcs->atomic_duplicate_state));
269 ret = __drm_mode_object_add(dev, &connector->base,
270 DRM_MODE_OBJECT_CONNECTOR,
271 false, drm_connector_free);
275 connector->base.properties = &connector->properties;
276 connector->dev = dev;
277 connector->funcs = funcs;
279 /* connector index is used with 32bit bitmasks */
280 ret = ida_alloc_max(&config->connector_ida, 31, GFP_KERNEL);
282 DRM_DEBUG_KMS("Failed to allocate %s connector index: %d\n",
283 drm_connector_enum_list[connector_type].name,
287 connector->index = ret;
290 connector->connector_type = connector_type;
291 connector->connector_type_id = 0;
293 drm_connector_get_of_name(connector_type, node_name, MAX_DT_NODE_NAME_LEN);
294 id = of_alias_get_id(dev->dev->of_node, node_name);
296 /* Try and allocate the requested ID
297 * Valid range is 1 to 31, hence ignoring 0 as an error
299 int type_id = ida_alloc_range(connector_ida, id, id, GFP_KERNEL);
302 connector->connector_type_id = type_id;
304 drm_err(dev, "Failed to acquire type ID %d for interface type %s, ret %d\n",
305 id, drm_connector_enum_list[connector_type].name,
308 if (!connector->connector_type_id)
309 connector->connector_type_id =
310 ida_alloc_min(connector_ida,
311 drm_connector_enum_list[connector_type].first_dyn_num,
313 if (connector->connector_type_id < 0) {
314 ret = connector->connector_type_id;
318 kasprintf(GFP_KERNEL, "%s-%d",
319 drm_connector_enum_list[connector_type].name,
320 connector->connector_type_id);
321 if (!connector->name) {
323 goto out_put_type_id;
326 /* provide ddc symlink in sysfs */
327 connector->ddc = ddc;
329 INIT_LIST_HEAD(&connector->global_connector_list_entry);
330 INIT_LIST_HEAD(&connector->probed_modes);
331 INIT_LIST_HEAD(&connector->modes);
332 mutex_init(&connector->mutex);
333 mutex_init(&connector->edid_override_mutex);
334 connector->edid_blob_ptr = NULL;
335 connector->epoch_counter = 0;
336 connector->tile_blob_ptr = NULL;
337 connector->status = connector_status_unknown;
338 connector->display_info.panel_orientation =
339 DRM_MODE_PANEL_ORIENTATION_UNKNOWN;
341 drm_connector_get_cmdline_mode(connector);
343 /* We should add connectors at the end to avoid upsetting the connector
346 spin_lock_irq(&config->connector_list_lock);
347 list_add_tail(&connector->head, &config->connector_list);
348 config->num_connector++;
349 spin_unlock_irq(&config->connector_list_lock);
351 if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL &&
352 connector_type != DRM_MODE_CONNECTOR_WRITEBACK)
353 drm_connector_attach_edid_property(connector);
355 drm_object_attach_property(&connector->base,
356 config->dpms_property, 0);
358 drm_object_attach_property(&connector->base,
359 config->link_status_property,
362 drm_object_attach_property(&connector->base,
363 config->non_desktop_property,
365 drm_object_attach_property(&connector->base,
366 config->tile_property,
369 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
370 drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
373 connector->debugfs_entry = NULL;
376 ida_free(connector_ida, connector->connector_type_id);
379 ida_free(&config->connector_ida, connector->index);
382 drm_mode_object_unregister(dev, &connector->base);
388 * drm_connector_init - Init a preallocated connector
390 * @connector: the connector to init
391 * @funcs: callbacks for this connector
392 * @connector_type: user visible type of the connector
394 * Initialises a preallocated connector. Connectors should be
395 * subclassed as part of driver connector objects.
397 * At driver unload time the driver's &drm_connector_funcs.destroy hook
398 * should call drm_connector_cleanup() and free the connector structure.
399 * The connector structure should not be allocated with devm_kzalloc().
401 * Note: consider using drmm_connector_init() instead of
402 * drm_connector_init() to let the DRM managed resource infrastructure
403 * take care of cleanup and deallocation.
406 * Zero on success, error code on failure.
408 int drm_connector_init(struct drm_device *dev,
409 struct drm_connector *connector,
410 const struct drm_connector_funcs *funcs,
413 if (drm_WARN_ON(dev, !(funcs && funcs->destroy)))
416 return __drm_connector_init(dev, connector, funcs, connector_type, NULL);
418 EXPORT_SYMBOL(drm_connector_init);
421 * drm_connector_init_with_ddc - Init a preallocated connector
423 * @connector: the connector to init
424 * @funcs: callbacks for this connector
425 * @connector_type: user visible type of the connector
426 * @ddc: pointer to the associated ddc adapter
428 * Initialises a preallocated connector. Connectors should be
429 * subclassed as part of driver connector objects.
431 * At driver unload time the driver's &drm_connector_funcs.destroy hook
432 * should call drm_connector_cleanup() and free the connector structure.
433 * The connector structure should not be allocated with devm_kzalloc().
435 * Ensures that the ddc field of the connector is correctly set.
437 * Note: consider using drmm_connector_init() instead of
438 * drm_connector_init_with_ddc() to let the DRM managed resource
439 * infrastructure take care of cleanup and deallocation.
442 * Zero on success, error code on failure.
444 int drm_connector_init_with_ddc(struct drm_device *dev,
445 struct drm_connector *connector,
446 const struct drm_connector_funcs *funcs,
448 struct i2c_adapter *ddc)
450 if (drm_WARN_ON(dev, !(funcs && funcs->destroy)))
453 return __drm_connector_init(dev, connector, funcs, connector_type, ddc);
455 EXPORT_SYMBOL(drm_connector_init_with_ddc);
457 static void drm_connector_cleanup_action(struct drm_device *dev,
460 struct drm_connector *connector = ptr;
462 drm_connector_cleanup(connector);
466 * drmm_connector_init - Init a preallocated connector
468 * @connector: the connector to init
469 * @funcs: callbacks for this connector
470 * @connector_type: user visible type of the connector
471 * @ddc: optional pointer to the associated ddc adapter
473 * Initialises a preallocated connector. Connectors should be
474 * subclassed as part of driver connector objects.
476 * Cleanup is automatically handled with a call to
477 * drm_connector_cleanup() in a DRM-managed action.
479 * The connector structure should be allocated with drmm_kzalloc().
482 * Zero on success, error code on failure.
484 int drmm_connector_init(struct drm_device *dev,
485 struct drm_connector *connector,
486 const struct drm_connector_funcs *funcs,
488 struct i2c_adapter *ddc)
492 if (drm_WARN_ON(dev, funcs && funcs->destroy))
495 ret = __drm_connector_init(dev, connector, funcs, connector_type, ddc);
499 ret = drmm_add_action_or_reset(dev, drm_connector_cleanup_action,
506 EXPORT_SYMBOL(drmm_connector_init);
509 * drm_connector_attach_edid_property - attach edid property.
510 * @connector: the connector
512 * Some connector types like DRM_MODE_CONNECTOR_VIRTUAL do not get a
513 * edid property attached by default. This function can be used to
514 * explicitly enable the edid property in these cases.
516 void drm_connector_attach_edid_property(struct drm_connector *connector)
518 struct drm_mode_config *config = &connector->dev->mode_config;
520 drm_object_attach_property(&connector->base,
521 config->edid_property,
524 EXPORT_SYMBOL(drm_connector_attach_edid_property);
527 * drm_connector_attach_encoder - attach a connector to an encoder
528 * @connector: connector to attach
529 * @encoder: encoder to attach @connector to
531 * This function links up a connector to an encoder. Note that the routing
532 * restrictions between encoders and crtcs are exposed to userspace through the
533 * possible_clones and possible_crtcs bitmasks.
536 * Zero on success, negative errno on failure.
538 int drm_connector_attach_encoder(struct drm_connector *connector,
539 struct drm_encoder *encoder)
542 * In the past, drivers have attempted to model the static association
543 * of connector to encoder in simple connector/encoder devices using a
544 * direct assignment of connector->encoder = encoder. This connection
545 * is a logical one and the responsibility of the core, so drivers are
546 * expected not to mess with this.
548 * Note that the error return should've been enough here, but a large
549 * majority of drivers ignores the return value, so add in a big WARN
550 * to get people's attention.
552 if (WARN_ON(connector->encoder))
555 connector->possible_encoders |= drm_encoder_mask(encoder);
559 EXPORT_SYMBOL(drm_connector_attach_encoder);
562 * drm_connector_has_possible_encoder - check if the connector and encoder are
563 * associated with each other
564 * @connector: the connector
565 * @encoder: the encoder
568 * True if @encoder is one of the possible encoders for @connector.
570 bool drm_connector_has_possible_encoder(struct drm_connector *connector,
571 struct drm_encoder *encoder)
573 return connector->possible_encoders & drm_encoder_mask(encoder);
575 EXPORT_SYMBOL(drm_connector_has_possible_encoder);
577 static void drm_mode_remove(struct drm_connector *connector,
578 struct drm_display_mode *mode)
580 list_del(&mode->head);
581 drm_mode_destroy(connector->dev, mode);
585 * drm_connector_cleanup - cleans up an initialised connector
586 * @connector: connector to cleanup
588 * Cleans up the connector but doesn't free the object.
590 void drm_connector_cleanup(struct drm_connector *connector)
592 struct drm_device *dev = connector->dev;
593 struct drm_display_mode *mode, *t;
595 /* The connector should have been removed from userspace long before
596 * it is finally destroyed.
598 if (WARN_ON(connector->registration_state ==
599 DRM_CONNECTOR_REGISTERED))
600 drm_connector_unregister(connector);
602 if (connector->privacy_screen) {
603 drm_privacy_screen_put(connector->privacy_screen);
604 connector->privacy_screen = NULL;
607 if (connector->tile_group) {
608 drm_mode_put_tile_group(dev, connector->tile_group);
609 connector->tile_group = NULL;
612 list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
613 drm_mode_remove(connector, mode);
615 list_for_each_entry_safe(mode, t, &connector->modes, head)
616 drm_mode_remove(connector, mode);
618 ida_free(&drm_connector_enum_list[connector->connector_type].ida,
619 connector->connector_type_id);
621 ida_free(&dev->mode_config.connector_ida, connector->index);
623 kfree(connector->display_info.bus_formats);
624 kfree(connector->display_info.vics);
625 drm_mode_object_unregister(dev, &connector->base);
626 kfree(connector->name);
627 connector->name = NULL;
628 fwnode_handle_put(connector->fwnode);
629 connector->fwnode = NULL;
630 spin_lock_irq(&dev->mode_config.connector_list_lock);
631 list_del(&connector->head);
632 dev->mode_config.num_connector--;
633 spin_unlock_irq(&dev->mode_config.connector_list_lock);
635 WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
636 if (connector->state && connector->funcs->atomic_destroy_state)
637 connector->funcs->atomic_destroy_state(connector,
640 mutex_destroy(&connector->mutex);
642 memset(connector, 0, sizeof(*connector));
645 drm_sysfs_hotplug_event(dev);
647 EXPORT_SYMBOL(drm_connector_cleanup);
650 * drm_connector_register - register a connector
651 * @connector: the connector to register
653 * Register userspace interfaces for a connector. Only call this for connectors
654 * which can be hotplugged after drm_dev_register() has been called already,
655 * e.g. DP MST connectors. All other connectors will be registered automatically
656 * when calling drm_dev_register().
658 * When the connector is no longer available, callers must call
659 * drm_connector_unregister().
662 * Zero on success, error code on failure.
664 int drm_connector_register(struct drm_connector *connector)
668 if (!connector->dev->registered)
671 mutex_lock(&connector->mutex);
672 if (connector->registration_state != DRM_CONNECTOR_INITIALIZING)
675 ret = drm_sysfs_connector_add(connector);
679 drm_debugfs_connector_add(connector);
681 if (connector->funcs->late_register) {
682 ret = connector->funcs->late_register(connector);
687 drm_mode_object_register(connector->dev, &connector->base);
689 connector->registration_state = DRM_CONNECTOR_REGISTERED;
691 /* Let userspace know we have a new connector */
692 drm_sysfs_connector_hotplug_event(connector);
694 if (connector->privacy_screen)
695 drm_privacy_screen_register_notifier(connector->privacy_screen,
696 &connector->privacy_screen_notifier);
698 mutex_lock(&connector_list_lock);
699 list_add_tail(&connector->global_connector_list_entry, &connector_list);
700 mutex_unlock(&connector_list_lock);
704 drm_debugfs_connector_remove(connector);
705 drm_sysfs_connector_remove(connector);
707 mutex_unlock(&connector->mutex);
710 EXPORT_SYMBOL(drm_connector_register);
713 * drm_connector_unregister - unregister a connector
714 * @connector: the connector to unregister
716 * Unregister userspace interfaces for a connector. Only call this for
717 * connectors which have been registered explicitly by calling
718 * drm_connector_register().
720 void drm_connector_unregister(struct drm_connector *connector)
722 mutex_lock(&connector->mutex);
723 if (connector->registration_state != DRM_CONNECTOR_REGISTERED) {
724 mutex_unlock(&connector->mutex);
728 mutex_lock(&connector_list_lock);
729 list_del_init(&connector->global_connector_list_entry);
730 mutex_unlock(&connector_list_lock);
732 if (connector->privacy_screen)
733 drm_privacy_screen_unregister_notifier(
734 connector->privacy_screen,
735 &connector->privacy_screen_notifier);
737 if (connector->funcs->early_unregister)
738 connector->funcs->early_unregister(connector);
740 drm_sysfs_connector_remove(connector);
741 drm_debugfs_connector_remove(connector);
743 connector->registration_state = DRM_CONNECTOR_UNREGISTERED;
744 mutex_unlock(&connector->mutex);
746 EXPORT_SYMBOL(drm_connector_unregister);
748 void drm_connector_unregister_all(struct drm_device *dev)
750 struct drm_connector *connector;
751 struct drm_connector_list_iter conn_iter;
753 drm_connector_list_iter_begin(dev, &conn_iter);
754 drm_for_each_connector_iter(connector, &conn_iter)
755 drm_connector_unregister(connector);
756 drm_connector_list_iter_end(&conn_iter);
759 int drm_connector_register_all(struct drm_device *dev)
761 struct drm_connector *connector;
762 struct drm_connector_list_iter conn_iter;
765 drm_connector_list_iter_begin(dev, &conn_iter);
766 drm_for_each_connector_iter(connector, &conn_iter) {
767 ret = drm_connector_register(connector);
771 drm_connector_list_iter_end(&conn_iter);
774 drm_connector_unregister_all(dev);
779 * drm_get_connector_status_name - return a string for connector status
780 * @status: connector status to compute name of
782 * In contrast to the other drm_get_*_name functions this one here returns a
783 * const pointer and hence is threadsafe.
785 * Returns: connector status string
787 const char *drm_get_connector_status_name(enum drm_connector_status status)
789 if (status == connector_status_connected)
791 else if (status == connector_status_disconnected)
792 return "disconnected";
796 EXPORT_SYMBOL(drm_get_connector_status_name);
799 * drm_get_connector_force_name - return a string for connector force
800 * @force: connector force to get name of
802 * Returns: const pointer to name.
804 const char *drm_get_connector_force_name(enum drm_connector_force force)
807 case DRM_FORCE_UNSPECIFIED:
808 return "unspecified";
813 case DRM_FORCE_ON_DIGITAL:
820 #ifdef CONFIG_LOCKDEP
821 static struct lockdep_map connector_list_iter_dep_map = {
822 .name = "drm_connector_list_iter"
827 * drm_connector_list_iter_begin - initialize a connector_list iterator
829 * @iter: connector_list iterator
831 * Sets @iter up to walk the &drm_mode_config.connector_list of @dev. @iter
832 * must always be cleaned up again by calling drm_connector_list_iter_end().
833 * Iteration itself happens using drm_connector_list_iter_next() or
834 * drm_for_each_connector_iter().
836 void drm_connector_list_iter_begin(struct drm_device *dev,
837 struct drm_connector_list_iter *iter)
841 lock_acquire_shared_recursive(&connector_list_iter_dep_map, 0, 1, NULL, _RET_IP_);
843 EXPORT_SYMBOL(drm_connector_list_iter_begin);
846 * Extra-safe connector put function that works in any context. Should only be
847 * used from the connector_iter functions, where we never really expect to
848 * actually release the connector when dropping our final reference.
851 __drm_connector_put_safe(struct drm_connector *conn)
853 struct drm_mode_config *config = &conn->dev->mode_config;
855 lockdep_assert_held(&config->connector_list_lock);
857 if (!refcount_dec_and_test(&conn->base.refcount.refcount))
860 llist_add(&conn->free_node, &config->connector_free_list);
861 schedule_work(&config->connector_free_work);
865 * drm_connector_list_iter_next - return next connector
866 * @iter: connector_list iterator
868 * Returns: the next connector for @iter, or NULL when the list walk has
871 struct drm_connector *
872 drm_connector_list_iter_next(struct drm_connector_list_iter *iter)
874 struct drm_connector *old_conn = iter->conn;
875 struct drm_mode_config *config = &iter->dev->mode_config;
876 struct list_head *lhead;
879 spin_lock_irqsave(&config->connector_list_lock, flags);
880 lhead = old_conn ? &old_conn->head : &config->connector_list;
883 if (lhead->next == &config->connector_list) {
889 iter->conn = list_entry(lhead, struct drm_connector, head);
891 /* loop until it's not a zombie connector */
892 } while (!kref_get_unless_zero(&iter->conn->base.refcount));
895 __drm_connector_put_safe(old_conn);
896 spin_unlock_irqrestore(&config->connector_list_lock, flags);
900 EXPORT_SYMBOL(drm_connector_list_iter_next);
903 * drm_connector_list_iter_end - tear down a connector_list iterator
904 * @iter: connector_list iterator
906 * Tears down @iter and releases any resources (like &drm_connector references)
907 * acquired while walking the list. This must always be called, both when the
908 * iteration completes fully or when it was aborted without walking the entire
911 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter)
913 struct drm_mode_config *config = &iter->dev->mode_config;
918 spin_lock_irqsave(&config->connector_list_lock, flags);
919 __drm_connector_put_safe(iter->conn);
920 spin_unlock_irqrestore(&config->connector_list_lock, flags);
922 lock_release(&connector_list_iter_dep_map, _RET_IP_);
924 EXPORT_SYMBOL(drm_connector_list_iter_end);
926 static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
927 { SubPixelUnknown, "Unknown" },
928 { SubPixelHorizontalRGB, "Horizontal RGB" },
929 { SubPixelHorizontalBGR, "Horizontal BGR" },
930 { SubPixelVerticalRGB, "Vertical RGB" },
931 { SubPixelVerticalBGR, "Vertical BGR" },
932 { SubPixelNone, "None" },
936 * drm_get_subpixel_order_name - return a string for a given subpixel enum
937 * @order: enum of subpixel_order
939 * Note you could abuse this and return something out of bounds, but that
940 * would be a caller error. No unscrubbed user data should make it here.
942 * Returns: string describing an enumerated subpixel property
944 const char *drm_get_subpixel_order_name(enum subpixel_order order)
946 return drm_subpixel_enum_list[order].name;
948 EXPORT_SYMBOL(drm_get_subpixel_order_name);
950 static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
951 { DRM_MODE_DPMS_ON, "On" },
952 { DRM_MODE_DPMS_STANDBY, "Standby" },
953 { DRM_MODE_DPMS_SUSPEND, "Suspend" },
954 { DRM_MODE_DPMS_OFF, "Off" }
956 DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
958 static const struct drm_prop_enum_list drm_link_status_enum_list[] = {
959 { DRM_MODE_LINK_STATUS_GOOD, "Good" },
960 { DRM_MODE_LINK_STATUS_BAD, "Bad" },
964 * drm_display_info_set_bus_formats - set the supported bus formats
965 * @info: display info to store bus formats in
966 * @formats: array containing the supported bus formats
967 * @num_formats: the number of entries in the fmts array
969 * Store the supported bus formats in display info structure.
970 * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
971 * a full list of available formats.
974 * 0 on success or a negative error code on failure.
976 int drm_display_info_set_bus_formats(struct drm_display_info *info,
978 unsigned int num_formats)
982 if (!formats && num_formats)
985 if (formats && num_formats) {
986 fmts = kmemdup(formats, sizeof(*formats) * num_formats,
992 kfree(info->bus_formats);
993 info->bus_formats = fmts;
994 info->num_bus_formats = num_formats;
998 EXPORT_SYMBOL(drm_display_info_set_bus_formats);
1000 /* Optional connector properties. */
1001 static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
1002 { DRM_MODE_SCALE_NONE, "None" },
1003 { DRM_MODE_SCALE_FULLSCREEN, "Full" },
1004 { DRM_MODE_SCALE_CENTER, "Center" },
1005 { DRM_MODE_SCALE_ASPECT, "Full aspect" },
1008 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
1009 { DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
1010 { DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
1011 { DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
1014 static const struct drm_prop_enum_list drm_content_type_enum_list[] = {
1015 { DRM_MODE_CONTENT_TYPE_NO_DATA, "No Data" },
1016 { DRM_MODE_CONTENT_TYPE_GRAPHICS, "Graphics" },
1017 { DRM_MODE_CONTENT_TYPE_PHOTO, "Photo" },
1018 { DRM_MODE_CONTENT_TYPE_CINEMA, "Cinema" },
1019 { DRM_MODE_CONTENT_TYPE_GAME, "Game" },
1022 static const struct drm_prop_enum_list drm_panel_orientation_enum_list[] = {
1023 { DRM_MODE_PANEL_ORIENTATION_NORMAL, "Normal" },
1024 { DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP, "Upside Down" },
1025 { DRM_MODE_PANEL_ORIENTATION_LEFT_UP, "Left Side Up" },
1026 { DRM_MODE_PANEL_ORIENTATION_RIGHT_UP, "Right Side Up" },
1029 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
1030 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
1031 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
1032 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
1034 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
1036 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
1037 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
1038 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
1039 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
1041 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
1042 drm_dvi_i_subconnector_enum_list)
1044 static const struct drm_prop_enum_list drm_tv_mode_enum_list[] = {
1045 { DRM_MODE_TV_MODE_NTSC, "NTSC" },
1046 { DRM_MODE_TV_MODE_NTSC_443, "NTSC-443" },
1047 { DRM_MODE_TV_MODE_NTSC_J, "NTSC-J" },
1048 { DRM_MODE_TV_MODE_PAL, "PAL" },
1049 { DRM_MODE_TV_MODE_PAL_M, "PAL-M" },
1050 { DRM_MODE_TV_MODE_PAL_N, "PAL-N" },
1051 { DRM_MODE_TV_MODE_SECAM, "SECAM" },
1053 DRM_ENUM_NAME_FN(drm_get_tv_mode_name, drm_tv_mode_enum_list)
1056 * drm_get_tv_mode_from_name - Translates a TV mode name into its enum value
1057 * @name: TV Mode name we want to convert
1058 * @len: Length of @name
1060 * Translates @name into an enum drm_connector_tv_mode.
1062 * Returns: the enum value on success, a negative errno otherwise.
1064 int drm_get_tv_mode_from_name(const char *name, size_t len)
1068 for (i = 0; i < ARRAY_SIZE(drm_tv_mode_enum_list); i++) {
1069 const struct drm_prop_enum_list *item = &drm_tv_mode_enum_list[i];
1071 if (strlen(item->name) == len && !strncmp(item->name, name, len))
1077 EXPORT_SYMBOL(drm_get_tv_mode_from_name);
1079 static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
1080 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
1081 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
1082 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
1083 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
1084 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
1086 DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
1088 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
1089 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
1090 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
1091 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
1092 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
1093 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
1095 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
1096 drm_tv_subconnector_enum_list)
1098 static const struct drm_prop_enum_list drm_dp_subconnector_enum_list[] = {
1099 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
1100 { DRM_MODE_SUBCONNECTOR_VGA, "VGA" }, /* DP */
1101 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DP */
1102 { DRM_MODE_SUBCONNECTOR_HDMIA, "HDMI" }, /* DP */
1103 { DRM_MODE_SUBCONNECTOR_DisplayPort, "DP" }, /* DP */
1104 { DRM_MODE_SUBCONNECTOR_Wireless, "Wireless" }, /* DP */
1105 { DRM_MODE_SUBCONNECTOR_Native, "Native" }, /* DP */
1108 DRM_ENUM_NAME_FN(drm_get_dp_subconnector_name,
1109 drm_dp_subconnector_enum_list)
1112 static const char * const colorspace_names[] = {
1113 /* For Default case, driver will set the colorspace */
1114 [DRM_MODE_COLORIMETRY_DEFAULT] = "Default",
1115 /* Standard Definition Colorimetry based on CEA 861 */
1116 [DRM_MODE_COLORIMETRY_SMPTE_170M_YCC] = "SMPTE_170M_YCC",
1117 [DRM_MODE_COLORIMETRY_BT709_YCC] = "BT709_YCC",
1118 /* Standard Definition Colorimetry based on IEC 61966-2-4 */
1119 [DRM_MODE_COLORIMETRY_XVYCC_601] = "XVYCC_601",
1120 /* High Definition Colorimetry based on IEC 61966-2-4 */
1121 [DRM_MODE_COLORIMETRY_XVYCC_709] = "XVYCC_709",
1122 /* Colorimetry based on IEC 61966-2-1/Amendment 1 */
1123 [DRM_MODE_COLORIMETRY_SYCC_601] = "SYCC_601",
1124 /* Colorimetry based on IEC 61966-2-5 [33] */
1125 [DRM_MODE_COLORIMETRY_OPYCC_601] = "opYCC_601",
1126 /* Colorimetry based on IEC 61966-2-5 */
1127 [DRM_MODE_COLORIMETRY_OPRGB] = "opRGB",
1128 /* Colorimetry based on ITU-R BT.2020 */
1129 [DRM_MODE_COLORIMETRY_BT2020_CYCC] = "BT2020_CYCC",
1130 /* Colorimetry based on ITU-R BT.2020 */
1131 [DRM_MODE_COLORIMETRY_BT2020_RGB] = "BT2020_RGB",
1132 /* Colorimetry based on ITU-R BT.2020 */
1133 [DRM_MODE_COLORIMETRY_BT2020_YCC] = "BT2020_YCC",
1134 /* Added as part of Additional Colorimetry Extension in 861.G */
1135 [DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65] = "DCI-P3_RGB_D65",
1136 [DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER] = "DCI-P3_RGB_Theater",
1137 [DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED] = "RGB_WIDE_FIXED",
1138 /* Colorimetry based on scRGB (IEC 61966-2-2) */
1139 [DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT] = "RGB_WIDE_FLOAT",
1140 [DRM_MODE_COLORIMETRY_BT601_YCC] = "BT601_YCC",
1144 * drm_get_colorspace_name - return a string for color encoding
1145 * @colorspace: color space to compute name of
1147 * In contrast to the other drm_get_*_name functions this one here returns a
1148 * const pointer and hence is threadsafe.
1150 const char *drm_get_colorspace_name(enum drm_colorspace colorspace)
1152 if (colorspace < ARRAY_SIZE(colorspace_names) && colorspace_names[colorspace])
1153 return colorspace_names[colorspace];
1158 static const u32 hdmi_colorspaces =
1159 BIT(DRM_MODE_COLORIMETRY_SMPTE_170M_YCC) |
1160 BIT(DRM_MODE_COLORIMETRY_BT709_YCC) |
1161 BIT(DRM_MODE_COLORIMETRY_XVYCC_601) |
1162 BIT(DRM_MODE_COLORIMETRY_XVYCC_709) |
1163 BIT(DRM_MODE_COLORIMETRY_SYCC_601) |
1164 BIT(DRM_MODE_COLORIMETRY_OPYCC_601) |
1165 BIT(DRM_MODE_COLORIMETRY_OPRGB) |
1166 BIT(DRM_MODE_COLORIMETRY_BT2020_CYCC) |
1167 BIT(DRM_MODE_COLORIMETRY_BT2020_RGB) |
1168 BIT(DRM_MODE_COLORIMETRY_BT2020_YCC) |
1169 BIT(DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65) |
1170 BIT(DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER);
1173 * As per DP 1.4a spec, 2.2.5.7.5 VSC SDP Payload for Pixel Encoding/Colorimetry
1174 * Format Table 2-120
1176 static const u32 dp_colorspaces =
1177 BIT(DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED) |
1178 BIT(DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT) |
1179 BIT(DRM_MODE_COLORIMETRY_OPRGB) |
1180 BIT(DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65) |
1181 BIT(DRM_MODE_COLORIMETRY_BT2020_RGB) |
1182 BIT(DRM_MODE_COLORIMETRY_BT601_YCC) |
1183 BIT(DRM_MODE_COLORIMETRY_BT709_YCC) |
1184 BIT(DRM_MODE_COLORIMETRY_XVYCC_601) |
1185 BIT(DRM_MODE_COLORIMETRY_XVYCC_709) |
1186 BIT(DRM_MODE_COLORIMETRY_SYCC_601) |
1187 BIT(DRM_MODE_COLORIMETRY_OPYCC_601) |
1188 BIT(DRM_MODE_COLORIMETRY_BT2020_CYCC) |
1189 BIT(DRM_MODE_COLORIMETRY_BT2020_YCC);
1192 * DOC: standard connector properties
1194 * DRM connectors have a few standardized properties:
1197 * Blob property which contains the current EDID read from the sink. This
1198 * is useful to parse sink identification information like vendor, model
1199 * and serial. Drivers should update this property by calling
1200 * drm_connector_update_edid_property(), usually after having parsed
1201 * the EDID using drm_add_edid_modes(). Userspace cannot change this
1204 * User-space should not parse the EDID to obtain information exposed via
1205 * other KMS properties (because the kernel might apply limits, quirks or
1206 * fixups to the EDID). For instance, user-space should not try to parse
1207 * mode lists from the EDID.
1209 * Legacy property for setting the power state of the connector. For atomic
1210 * drivers this is only provided for backwards compatibility with existing
1211 * drivers, it remaps to controlling the "ACTIVE" property on the CRTC the
1212 * connector is linked to. Drivers should never set this property directly,
1213 * it is handled by the DRM core by calling the &drm_connector_funcs.dpms
1214 * callback. For atomic drivers the remapping to the "ACTIVE" property is
1215 * implemented in the DRM core.
1217 * Note that this property cannot be set through the MODE_ATOMIC ioctl,
1218 * userspace must use "ACTIVE" on the CRTC instead.
1222 * For userspace also running on legacy drivers the "DPMS" semantics are a
1223 * lot more complicated. First, userspace cannot rely on the "DPMS" value
1224 * returned by the GETCONNECTOR actually reflecting reality, because many
1225 * drivers fail to update it. For atomic drivers this is taken care of in
1226 * drm_atomic_helper_update_legacy_modeset_state().
1228 * The second issue is that the DPMS state is only well-defined when the
1229 * connector is connected to a CRTC. In atomic the DRM core enforces that
1230 * "ACTIVE" is off in such a case, no such checks exists for "DPMS".
1232 * Finally, when enabling an output using the legacy SETCONFIG ioctl then
1233 * "DPMS" is forced to ON. But see above, that might not be reflected in
1234 * the software value on legacy drivers.
1236 * Summarizing: Only set "DPMS" when the connector is known to be enabled,
1237 * assume that a successful SETCONFIG call also sets "DPMS" to on, and
1238 * never read back the value of "DPMS" because it can be incorrect.
1240 * Connector path property to identify how this sink is physically
1241 * connected. Used by DP MST. This should be set by calling
1242 * drm_connector_set_path_property(), in the case of DP MST with the
1243 * path property the MST manager created. Userspace cannot change this
1246 * Connector tile group property to indicate how a set of DRM connector
1247 * compose together into one logical screen. This is used by both high-res
1248 * external screens (often only using a single cable, but exposing multiple
1249 * DP MST sinks), or high-res integrated panels (like dual-link DSI) which
1250 * are not gen-locked. Note that for tiled panels which are genlocked, like
1251 * dual-link LVDS or dual-link DSI, the driver should try to not expose the
1252 * tiling and virtualise both &drm_crtc and &drm_plane if needed. Drivers
1253 * should update this value using drm_connector_set_tile_property().
1254 * Userspace cannot change this property.
1256 * Connector link-status property to indicate the status of link. The
1257 * default value of link-status is "GOOD". If something fails during or
1258 * after modeset, the kernel driver may set this to "BAD" and issue a
1259 * hotplug uevent. Drivers should update this value using
1260 * drm_connector_set_link_status_property().
1262 * When user-space receives the hotplug uevent and detects a "BAD"
1263 * link-status, the sink doesn't receive pixels anymore (e.g. the screen
1264 * becomes completely black). The list of available modes may have
1265 * changed. User-space is expected to pick a new mode if the current one
1266 * has disappeared and perform a new modeset with link-status set to
1267 * "GOOD" to re-enable the connector.
1269 * If multiple connectors share the same CRTC and one of them gets a "BAD"
1270 * link-status, the other are unaffected (ie. the sinks still continue to
1273 * When user-space performs an atomic commit on a connector with a "BAD"
1274 * link-status without resetting the property to "GOOD", the sink may
1275 * still not receive pixels. When user-space performs an atomic commit
1276 * which resets the link-status property to "GOOD" without the
1277 * ALLOW_MODESET flag set, it might fail because a modeset is required.
1279 * User-space can only change link-status to "GOOD", changing it to "BAD"
1282 * For backwards compatibility with non-atomic userspace the kernel
1283 * tries to automatically set the link-status back to "GOOD" in the
1284 * SETCRTC IOCTL. This might fail if the mode is no longer valid, similar
1285 * to how it might fail if a different screen has been connected in the
1288 * Indicates the output should be ignored for purposes of displaying a
1289 * standard desktop environment or console. This is most likely because
1290 * the output device is not rectilinear.
1291 * Content Protection:
1292 * This property is used by userspace to request the kernel protect future
1293 * content communicated over the link. When requested, kernel will apply
1294 * the appropriate means of protection (most often HDCP), and use the
1295 * property to tell userspace the protection is active.
1297 * Drivers can set this up by calling
1298 * drm_connector_attach_content_protection_property() on initialization.
1300 * The value of this property can be one of the following:
1302 * DRM_MODE_CONTENT_PROTECTION_UNDESIRED = 0
1303 * The link is not protected, content is transmitted in the clear.
1304 * DRM_MODE_CONTENT_PROTECTION_DESIRED = 1
1305 * Userspace has requested content protection, but the link is not
1306 * currently protected. When in this state, kernel should enable
1307 * Content Protection as soon as possible.
1308 * DRM_MODE_CONTENT_PROTECTION_ENABLED = 2
1309 * Userspace has requested content protection, and the link is
1310 * protected. Only the driver can set the property to this value.
1311 * If userspace attempts to set to ENABLED, kernel will return
1316 * - DESIRED state should be preserved until userspace de-asserts it by
1317 * setting the property to UNDESIRED. This means ENABLED should only
1318 * transition to UNDESIRED when the user explicitly requests it.
1319 * - If the state is DESIRED, kernel should attempt to re-authenticate the
1320 * link whenever possible. This includes across disable/enable, dpms,
1321 * hotplug, downstream device changes, link status failures, etc..
1322 * - Kernel sends uevent with the connector id and property id through
1323 * @drm_hdcp_update_content_protection, upon below kernel triggered
1326 * - DESIRED -> ENABLED (authentication success)
1327 * - ENABLED -> DESIRED (termination of authentication)
1328 * - Please note no uevents for userspace triggered property state changes,
1329 * which can't fail such as
1331 * - DESIRED/ENABLED -> UNDESIRED
1332 * - UNDESIRED -> DESIRED
1333 * - Userspace is responsible for polling the property or listen to uevents
1334 * to determine when the value transitions from ENABLED to DESIRED.
1335 * This signifies the link is no longer protected and userspace should
1336 * take appropriate action (whatever that might be).
1338 * HDCP Content Type:
1339 * This Enum property is used by the userspace to declare the content type
1340 * of the display stream, to kernel. Here display stream stands for any
1341 * display content that userspace intended to display through HDCP
1344 * Content Type of a stream is decided by the owner of the stream, as
1345 * "HDCP Type0" or "HDCP Type1".
1347 * The value of the property can be one of the below:
1348 * - "HDCP Type0": DRM_MODE_HDCP_CONTENT_TYPE0 = 0
1349 * - "HDCP Type1": DRM_MODE_HDCP_CONTENT_TYPE1 = 1
1351 * When kernel starts the HDCP authentication (see "Content Protection"
1352 * for details), it uses the content type in "HDCP Content Type"
1353 * for performing the HDCP authentication with the display sink.
1355 * Please note in HDCP spec versions, a link can be authenticated with
1356 * HDCP 2.2 for Content Type 0/Content Type 1. Where as a link can be
1357 * authenticated with HDCP1.4 only for Content Type 0(though it is implicit
1358 * in nature. As there is no reference for Content Type in HDCP1.4).
1360 * HDCP2.2 authentication protocol itself takes the "Content Type" as a
1361 * parameter, which is a input for the DP HDCP2.2 encryption algo.
1363 * In case of Type 0 content protection request, kernel driver can choose
1364 * either of HDCP spec versions 1.4 and 2.2. When HDCP2.2 is used for
1365 * "HDCP Type 0", a HDCP 2.2 capable repeater in the downstream can send
1366 * that content to a HDCP 1.4 authenticated HDCP sink (Type0 link).
1367 * But if the content is classified as "HDCP Type 1", above mentioned
1368 * HDCP 2.2 repeater wont send the content to the HDCP sink as it can't
1369 * authenticate the HDCP1.4 capable sink for "HDCP Type 1".
1371 * Please note userspace can be ignorant of the HDCP versions used by the
1372 * kernel driver to achieve the "HDCP Content Type".
1374 * At current scenario, classifying a content as Type 1 ensures that the
1375 * content will be displayed only through the HDCP2.2 encrypted link.
1377 * Note that the HDCP Content Type property is introduced at HDCP 2.2, and
1378 * defaults to type 0. It is only exposed by drivers supporting HDCP 2.2
1379 * (hence supporting Type 0 and Type 1). Based on how next versions of
1380 * HDCP specs are defined content Type could be used for higher versions
1383 * If content type is changed when "Content Protection" is not UNDESIRED,
1384 * then kernel will disable the HDCP and re-enable with new type in the
1385 * same atomic commit. And when "Content Protection" is ENABLED, it means
1386 * that link is HDCP authenticated and encrypted, for the transmission of
1387 * the Type of stream mentioned at "HDCP Content Type".
1389 * HDR_OUTPUT_METADATA:
1390 * Connector property to enable userspace to send HDR Metadata to
1391 * driver. This metadata is based on the composition and blending
1392 * policies decided by user, taking into account the hardware and
1393 * sink capabilities. The driver gets this metadata and creates a
1394 * Dynamic Range and Mastering Infoframe (DRM) in case of HDMI,
1395 * SDP packet (Non-audio INFOFRAME SDP v1.3) for DP. This is then
1396 * sent to sink. This notifies the sink of the upcoming frame's Color
1397 * Encoding and Luminance parameters.
1399 * Userspace first need to detect the HDR capabilities of sink by
1400 * reading and parsing the EDID. Details of HDR metadata for HDMI
1401 * are added in CTA 861.G spec. For DP , its defined in VESA DP
1402 * Standard v1.4. It needs to then get the metadata information
1403 * of the video/game/app content which are encoded in HDR (basically
1404 * using HDR transfer functions). With this information it needs to
1405 * decide on a blending policy and compose the relevant
1406 * layers/overlays into a common format. Once this blending is done,
1407 * userspace will be aware of the metadata of the composed frame to
1408 * be send to sink. It then uses this property to communicate this
1409 * metadata to driver which then make a Infoframe packet and sends
1410 * to sink based on the type of encoder connected.
1412 * Userspace will be responsible to do Tone mapping operation in case:
1413 * - Some layers are HDR and others are SDR
1414 * - HDR layers luminance is not same as sink
1416 * It will even need to do colorspace conversion and get all layers
1417 * to one common colorspace for blending. It can use either GL, Media
1418 * or display engine to get this done based on the capabilities of the
1419 * associated hardware.
1421 * Driver expects metadata to be put in &struct hdr_output_metadata
1422 * structure from userspace. This is received as blob and stored in
1423 * &drm_connector_state.hdr_output_metadata. It parses EDID and saves the
1424 * sink metadata in &struct hdr_sink_metadata, as
1425 * &drm_connector.hdr_sink_metadata. Driver uses
1426 * drm_hdmi_infoframe_set_hdr_metadata() helper to set the HDR metadata,
1427 * hdmi_drm_infoframe_pack() to pack the infoframe as per spec, in case of
1431 * This range property is used by userspace to limit the bit depth. When
1432 * used the driver would limit the bpc in accordance with the valid range
1433 * supported by the hardware and sink. Drivers to use the function
1434 * drm_connector_attach_max_bpc_property() to create and attach the
1435 * property to the connector during initialization.
1437 * Connectors also have one standardized atomic property:
1440 * Mode object ID of the &drm_crtc this connector should be connected to.
1442 * Connectors for LCD panels may also have one standardized property:
1444 * panel orientation:
1445 * On some devices the LCD panel is mounted in the casing in such a way
1446 * that the up/top side of the panel does not match with the top side of
1447 * the device. Userspace can use this property to check for this.
1448 * Note that input coordinates from touchscreens (input devices with
1449 * INPUT_PROP_DIRECT) will still map 1:1 to the actual LCD panel
1450 * coordinates, so if userspace rotates the picture to adjust for
1451 * the orientation it must also apply the same transformation to the
1452 * touchscreen input coordinates. This property is initialized by calling
1453 * drm_connector_set_panel_orientation() or
1454 * drm_connector_set_panel_orientation_with_quirk()
1457 * This property defines how a non-native mode is upscaled to the native
1458 * mode of an LCD panel:
1461 * No upscaling happens, scaling is left to the panel. Not all
1462 * drivers expose this mode.
1464 * The output is upscaled to the full resolution of the panel,
1465 * ignoring the aspect ratio.
1467 * No upscaling happens, the output is centered within the native
1468 * resolution the panel.
1470 * The output is upscaled to maximize either the width or height
1471 * while retaining the aspect ratio.
1473 * This property should be set up by calling
1474 * drm_connector_attach_scaling_mode_property(). Note that drivers
1475 * can also expose this property to external outputs, in which case they
1476 * must support "None", which should be the default (since external screens
1477 * have a built-in scaler).
1480 * This property is used by DVI-I, TVout and DisplayPort to indicate different
1481 * connector subtypes. Enum values more or less match with those from main
1483 * For DVI-I and TVout there is also a matching property "select subconnector"
1484 * allowing to switch between signal types.
1485 * DP subconnector corresponds to a downstream port.
1487 * privacy-screen sw-state, privacy-screen hw-state:
1488 * These 2 optional properties can be used to query the state of the
1489 * electronic privacy screen that is available on some displays; and in
1490 * some cases also control the state. If a driver implements these
1491 * properties then both properties must be present.
1493 * "privacy-screen hw-state" is read-only and reflects the actual state
1494 * of the privacy-screen, possible values: "Enabled", "Disabled,
1495 * "Enabled-locked", "Disabled-locked". The locked states indicate
1496 * that the state cannot be changed through the DRM API. E.g. there
1497 * might be devices where the firmware-setup options, or a hardware
1498 * slider-switch, offer always on / off modes.
1500 * "privacy-screen sw-state" can be set to change the privacy-screen state
1501 * when not locked. In this case the driver must update the hw-state
1502 * property to reflect the new state on completion of the commit of the
1503 * sw-state property. Setting the sw-state property when the hw-state is
1504 * locked must be interpreted by the driver as a request to change the
1505 * state to the set state when the hw-state becomes unlocked. E.g. if
1506 * "privacy-screen hw-state" is "Enabled-locked" and the sw-state
1507 * gets set to "Disabled" followed by the user unlocking the state by
1508 * changing the slider-switch position, then the driver must set the
1509 * state to "Disabled" upon receiving the unlock event.
1511 * In some cases the privacy-screen's actual state might change outside of
1512 * control of the DRM code. E.g. there might be a firmware handled hotkey
1513 * which toggles the actual state, or the actual state might be changed
1514 * through another userspace API such as writing /proc/acpi/ibm/lcdshadow.
1515 * In this case the driver must update both the hw-state and the sw-state
1516 * to reflect the new value, overwriting any pending state requests in the
1517 * sw-state. Any pending sw-state requests are thus discarded.
1519 * Note that the ability for the state to change outside of control of
1520 * the DRM master process means that userspace must not cache the value
1521 * of the sw-state. Caching the sw-state value and including it in later
1522 * atomic commits may lead to overriding a state change done through e.g.
1523 * a firmware handled hotkey. Therefor userspace must not include the
1524 * privacy-screen sw-state in an atomic commit unless it wants to change
1527 * left margin, right margin, top margin, bottom margin:
1528 * Add margins to the connector's viewport. This is typically used to
1529 * mitigate overscan on TVs.
1531 * The value is the size in pixels of the black border which will be
1532 * added. The attached CRTC's content will be scaled to fill the whole
1533 * area inside the margin.
1535 * The margins configuration might be sent to the sink, e.g. via HDMI AVI
1538 * Drivers can set up these properties by calling
1539 * drm_mode_create_tv_margin_properties().
1542 int drm_connector_create_standard_properties(struct drm_device *dev)
1544 struct drm_property *prop;
1546 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1547 DRM_MODE_PROP_IMMUTABLE,
1551 dev->mode_config.edid_property = prop;
1553 prop = drm_property_create_enum(dev, 0,
1554 "DPMS", drm_dpms_enum_list,
1555 ARRAY_SIZE(drm_dpms_enum_list));
1558 dev->mode_config.dpms_property = prop;
1560 prop = drm_property_create(dev,
1561 DRM_MODE_PROP_BLOB |
1562 DRM_MODE_PROP_IMMUTABLE,
1566 dev->mode_config.path_property = prop;
1568 prop = drm_property_create(dev,
1569 DRM_MODE_PROP_BLOB |
1570 DRM_MODE_PROP_IMMUTABLE,
1574 dev->mode_config.tile_property = prop;
1576 prop = drm_property_create_enum(dev, 0, "link-status",
1577 drm_link_status_enum_list,
1578 ARRAY_SIZE(drm_link_status_enum_list));
1581 dev->mode_config.link_status_property = prop;
1583 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE, "non-desktop");
1586 dev->mode_config.non_desktop_property = prop;
1588 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB,
1589 "HDR_OUTPUT_METADATA", 0);
1592 dev->mode_config.hdr_output_metadata_property = prop;
1598 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1601 * Called by a driver the first time a DVI-I connector is made.
1605 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1607 struct drm_property *dvi_i_selector;
1608 struct drm_property *dvi_i_subconnector;
1610 if (dev->mode_config.dvi_i_select_subconnector_property)
1614 drm_property_create_enum(dev, 0,
1615 "select subconnector",
1616 drm_dvi_i_select_enum_list,
1617 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1618 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1620 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1622 drm_dvi_i_subconnector_enum_list,
1623 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1624 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1628 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1631 * drm_connector_attach_dp_subconnector_property - create subconnector property for DP
1632 * @connector: drm_connector to attach property
1634 * Called by a driver when DP connector is created.
1636 void drm_connector_attach_dp_subconnector_property(struct drm_connector *connector)
1638 struct drm_mode_config *mode_config = &connector->dev->mode_config;
1640 if (!mode_config->dp_subconnector_property)
1641 mode_config->dp_subconnector_property =
1642 drm_property_create_enum(connector->dev,
1643 DRM_MODE_PROP_IMMUTABLE,
1645 drm_dp_subconnector_enum_list,
1646 ARRAY_SIZE(drm_dp_subconnector_enum_list));
1648 drm_object_attach_property(&connector->base,
1649 mode_config->dp_subconnector_property,
1650 DRM_MODE_SUBCONNECTOR_Unknown);
1652 EXPORT_SYMBOL(drm_connector_attach_dp_subconnector_property);
1655 * DOC: HDMI connector properties
1657 * content type (HDMI specific):
1658 * Indicates content type setting to be used in HDMI infoframes to indicate
1659 * content type for the external device, so that it adjusts its display
1660 * settings accordingly.
1662 * The value of this property can be one of the following:
1665 * Content type is unknown
1667 * Content type is graphics
1669 * Content type is photo
1671 * Content type is cinema
1673 * Content type is game
1675 * The meaning of each content type is defined in CTA-861-G table 15.
1677 * Drivers can set up this property by calling
1678 * drm_connector_attach_content_type_property(). Decoding to
1679 * infoframe values is done through drm_hdmi_avi_infoframe_content_type().
1683 * TODO: Document the properties:
1686 * - flicker reduction
1691 * - select subconnector
1694 * DOC: Analog TV Connector Properties
1697 * Indicates the TV Mode used on an analog TV connector. The value
1698 * of this property can be one of the following:
1701 * TV Mode is CCIR System M (aka 525-lines) together with
1702 * the NTSC Color Encoding.
1706 * TV Mode is CCIR System M (aka 525-lines) together with
1707 * the NTSC Color Encoding, but with a color subcarrier
1708 * frequency of 4.43MHz
1712 * TV Mode is CCIR System M (aka 525-lines) together with
1713 * the NTSC Color Encoding, but with a black level equal to
1714 * the blanking level.
1718 * TV Mode is CCIR System B (aka 625-lines) together with
1719 * the PAL Color Encoding.
1723 * TV Mode is CCIR System M (aka 525-lines) together with
1724 * the PAL Color Encoding.
1728 * TV Mode is CCIR System N together with the PAL Color
1729 * Encoding, a color subcarrier frequency of 3.58MHz, the
1730 * SECAM color space, and narrower channels than other PAL
1735 * TV Mode is CCIR System B (aka 625-lines) together with
1736 * the SECAM Color Encoding.
1738 * Drivers can set up this property by calling
1739 * drm_mode_create_tv_properties().
1743 * drm_connector_attach_content_type_property - attach content-type property
1744 * @connector: connector to attach content type property on.
1746 * Called by a driver the first time a HDMI connector is made.
1750 int drm_connector_attach_content_type_property(struct drm_connector *connector)
1752 if (!drm_mode_create_content_type_property(connector->dev))
1753 drm_object_attach_property(&connector->base,
1754 connector->dev->mode_config.content_type_property,
1755 DRM_MODE_CONTENT_TYPE_NO_DATA);
1758 EXPORT_SYMBOL(drm_connector_attach_content_type_property);
1761 * drm_connector_attach_tv_margin_properties - attach TV connector margin
1763 * @connector: DRM connector
1765 * Called by a driver when it needs to attach TV margin props to a connector.
1766 * Typically used on SDTV and HDMI connectors.
1768 void drm_connector_attach_tv_margin_properties(struct drm_connector *connector)
1770 struct drm_device *dev = connector->dev;
1772 drm_object_attach_property(&connector->base,
1773 dev->mode_config.tv_left_margin_property,
1775 drm_object_attach_property(&connector->base,
1776 dev->mode_config.tv_right_margin_property,
1778 drm_object_attach_property(&connector->base,
1779 dev->mode_config.tv_top_margin_property,
1781 drm_object_attach_property(&connector->base,
1782 dev->mode_config.tv_bottom_margin_property,
1785 EXPORT_SYMBOL(drm_connector_attach_tv_margin_properties);
1788 * drm_mode_create_tv_margin_properties - create TV connector margin properties
1791 * Called by a driver's HDMI connector initialization routine, this function
1792 * creates the TV margin properties for a given device. No need to call this
1793 * function for an SDTV connector, it's already called from
1794 * drm_mode_create_tv_properties_legacy().
1797 * 0 on success or a negative error code on failure.
1799 int drm_mode_create_tv_margin_properties(struct drm_device *dev)
1801 if (dev->mode_config.tv_left_margin_property)
1804 dev->mode_config.tv_left_margin_property =
1805 drm_property_create_range(dev, 0, "left margin", 0, 100);
1806 if (!dev->mode_config.tv_left_margin_property)
1809 dev->mode_config.tv_right_margin_property =
1810 drm_property_create_range(dev, 0, "right margin", 0, 100);
1811 if (!dev->mode_config.tv_right_margin_property)
1814 dev->mode_config.tv_top_margin_property =
1815 drm_property_create_range(dev, 0, "top margin", 0, 100);
1816 if (!dev->mode_config.tv_top_margin_property)
1819 dev->mode_config.tv_bottom_margin_property =
1820 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1821 if (!dev->mode_config.tv_bottom_margin_property)
1826 EXPORT_SYMBOL(drm_mode_create_tv_margin_properties);
1829 * drm_mode_create_tv_properties_legacy - create TV specific connector properties
1831 * @num_modes: number of different TV formats (modes) supported
1832 * @modes: array of pointers to strings containing name of each format
1834 * Called by a driver's TV initialization routine, this function creates
1835 * the TV specific connector properties for a given device. Caller is
1836 * responsible for allocating a list of format names and passing them to
1839 * NOTE: This functions registers the deprecated "mode" connector
1840 * property to select the analog TV mode (ie, NTSC, PAL, etc.). New
1841 * drivers must use drm_mode_create_tv_properties() instead.
1844 * 0 on success or a negative error code on failure.
1846 int drm_mode_create_tv_properties_legacy(struct drm_device *dev,
1847 unsigned int num_modes,
1848 const char * const modes[])
1850 struct drm_property *tv_selector;
1851 struct drm_property *tv_subconnector;
1854 if (dev->mode_config.tv_select_subconnector_property)
1858 * Basic connector properties
1860 tv_selector = drm_property_create_enum(dev, 0,
1861 "select subconnector",
1862 drm_tv_select_enum_list,
1863 ARRAY_SIZE(drm_tv_select_enum_list));
1867 dev->mode_config.tv_select_subconnector_property = tv_selector;
1870 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1872 drm_tv_subconnector_enum_list,
1873 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1874 if (!tv_subconnector)
1876 dev->mode_config.tv_subconnector_property = tv_subconnector;
1879 * Other, TV specific properties: margins & TV modes.
1881 if (drm_mode_create_tv_margin_properties(dev))
1885 dev->mode_config.legacy_tv_mode_property =
1886 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1888 if (!dev->mode_config.legacy_tv_mode_property)
1891 for (i = 0; i < num_modes; i++)
1892 drm_property_add_enum(dev->mode_config.legacy_tv_mode_property,
1896 dev->mode_config.tv_brightness_property =
1897 drm_property_create_range(dev, 0, "brightness", 0, 100);
1898 if (!dev->mode_config.tv_brightness_property)
1901 dev->mode_config.tv_contrast_property =
1902 drm_property_create_range(dev, 0, "contrast", 0, 100);
1903 if (!dev->mode_config.tv_contrast_property)
1906 dev->mode_config.tv_flicker_reduction_property =
1907 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1908 if (!dev->mode_config.tv_flicker_reduction_property)
1911 dev->mode_config.tv_overscan_property =
1912 drm_property_create_range(dev, 0, "overscan", 0, 100);
1913 if (!dev->mode_config.tv_overscan_property)
1916 dev->mode_config.tv_saturation_property =
1917 drm_property_create_range(dev, 0, "saturation", 0, 100);
1918 if (!dev->mode_config.tv_saturation_property)
1921 dev->mode_config.tv_hue_property =
1922 drm_property_create_range(dev, 0, "hue", 0, 100);
1923 if (!dev->mode_config.tv_hue_property)
1930 EXPORT_SYMBOL(drm_mode_create_tv_properties_legacy);
1933 * drm_mode_create_tv_properties - create TV specific connector properties
1935 * @supported_tv_modes: Bitmask of TV modes supported (See DRM_MODE_TV_MODE_*)
1937 * Called by a driver's TV initialization routine, this function creates
1938 * the TV specific connector properties for a given device.
1941 * 0 on success or a negative error code on failure.
1943 int drm_mode_create_tv_properties(struct drm_device *dev,
1944 unsigned int supported_tv_modes)
1946 struct drm_prop_enum_list tv_mode_list[DRM_MODE_TV_MODE_MAX];
1947 struct drm_property *tv_mode;
1948 unsigned int i, len = 0;
1950 if (dev->mode_config.tv_mode_property)
1953 for (i = 0; i < DRM_MODE_TV_MODE_MAX; i++) {
1954 if (!(supported_tv_modes & BIT(i)))
1957 tv_mode_list[len].type = i;
1958 tv_mode_list[len].name = drm_get_tv_mode_name(i);
1962 tv_mode = drm_property_create_enum(dev, 0, "TV mode",
1967 dev->mode_config.tv_mode_property = tv_mode;
1969 return drm_mode_create_tv_properties_legacy(dev, 0, NULL);
1971 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1974 * drm_mode_create_scaling_mode_property - create scaling mode property
1977 * Called by a driver the first time it's needed, must be attached to desired
1980 * Atomic drivers should use drm_connector_attach_scaling_mode_property()
1981 * instead to correctly assign &drm_connector_state.scaling_mode
1982 * in the atomic state.
1986 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1988 struct drm_property *scaling_mode;
1990 if (dev->mode_config.scaling_mode_property)
1994 drm_property_create_enum(dev, 0, "scaling mode",
1995 drm_scaling_mode_enum_list,
1996 ARRAY_SIZE(drm_scaling_mode_enum_list));
1998 dev->mode_config.scaling_mode_property = scaling_mode;
2002 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
2005 * DOC: Variable refresh properties
2007 * Variable refresh rate capable displays can dynamically adjust their
2008 * refresh rate by extending the duration of their vertical front porch
2009 * until page flip or timeout occurs. This can reduce or remove stuttering
2010 * and latency in scenarios where the page flip does not align with the
2013 * An example scenario would be an application flipping at a constant rate
2014 * of 48Hz on a 60Hz display. The page flip will frequently miss the vblank
2015 * interval and the same contents will be displayed twice. This can be
2016 * observed as stuttering for content with motion.
2018 * If variable refresh rate was active on a display that supported a
2019 * variable refresh range from 35Hz to 60Hz no stuttering would be observable
2020 * for the example scenario. The minimum supported variable refresh rate of
2021 * 35Hz is below the page flip frequency and the vertical front porch can
2022 * be extended until the page flip occurs. The vblank interval will be
2023 * directly aligned to the page flip rate.
2025 * Not all userspace content is suitable for use with variable refresh rate.
2026 * Large and frequent changes in vertical front porch duration may worsen
2027 * perceived stuttering for input sensitive applications.
2029 * Panel brightness will also vary with vertical front porch duration. Some
2030 * panels may have noticeable differences in brightness between the minimum
2031 * vertical front porch duration and the maximum vertical front porch duration.
2032 * Large and frequent changes in vertical front porch duration may produce
2033 * observable flickering for such panels.
2035 * Userspace control for variable refresh rate is supported via properties
2036 * on the &drm_connector and &drm_crtc objects.
2039 * Optional &drm_connector boolean property that drivers should attach
2040 * with drm_connector_attach_vrr_capable_property() on connectors that
2041 * could support variable refresh rates. Drivers should update the
2042 * property value by calling drm_connector_set_vrr_capable_property().
2044 * Absence of the property should indicate absence of support.
2047 * Default &drm_crtc boolean property that notifies the driver that the
2048 * content on the CRTC is suitable for variable refresh rate presentation.
2049 * The driver will take this property as a hint to enable variable
2050 * refresh rate support if the receiver supports it, ie. if the
2051 * "vrr_capable" property is true on the &drm_connector object. The
2052 * vertical front porch duration will be extended until page-flip or
2053 * timeout when enabled.
2055 * The minimum vertical front porch duration is defined as the vertical
2056 * front porch duration for the current mode.
2058 * The maximum vertical front porch duration is greater than or equal to
2059 * the minimum vertical front porch duration. The duration is derived
2060 * from the minimum supported variable refresh rate for the connector.
2062 * The driver may place further restrictions within these minimum
2063 * and maximum bounds.
2067 * drm_connector_attach_vrr_capable_property - creates the
2068 * vrr_capable property
2069 * @connector: connector to create the vrr_capable property on.
2071 * This is used by atomic drivers to add support for querying
2072 * variable refresh rate capability for a connector.
2075 * Zero on success, negative errno on failure.
2077 int drm_connector_attach_vrr_capable_property(
2078 struct drm_connector *connector)
2080 struct drm_device *dev = connector->dev;
2081 struct drm_property *prop;
2083 if (!connector->vrr_capable_property) {
2084 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE,
2089 connector->vrr_capable_property = prop;
2090 drm_object_attach_property(&connector->base, prop, 0);
2095 EXPORT_SYMBOL(drm_connector_attach_vrr_capable_property);
2098 * drm_connector_attach_scaling_mode_property - attach atomic scaling mode property
2099 * @connector: connector to attach scaling mode property on.
2100 * @scaling_mode_mask: or'ed mask of BIT(%DRM_MODE_SCALE_\*).
2102 * This is used to add support for scaling mode to atomic drivers.
2103 * The scaling mode will be set to &drm_connector_state.scaling_mode
2104 * and can be used from &drm_connector_helper_funcs->atomic_check for validation.
2106 * This is the atomic version of drm_mode_create_scaling_mode_property().
2109 * Zero on success, negative errno on failure.
2111 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
2112 u32 scaling_mode_mask)
2114 struct drm_device *dev = connector->dev;
2115 struct drm_property *scaling_mode_property;
2117 const unsigned valid_scaling_mode_mask =
2118 (1U << ARRAY_SIZE(drm_scaling_mode_enum_list)) - 1;
2120 if (WARN_ON(hweight32(scaling_mode_mask) < 2 ||
2121 scaling_mode_mask & ~valid_scaling_mode_mask))
2124 scaling_mode_property =
2125 drm_property_create(dev, DRM_MODE_PROP_ENUM, "scaling mode",
2126 hweight32(scaling_mode_mask));
2128 if (!scaling_mode_property)
2131 for (i = 0; i < ARRAY_SIZE(drm_scaling_mode_enum_list); i++) {
2134 if (!(BIT(i) & scaling_mode_mask))
2137 ret = drm_property_add_enum(scaling_mode_property,
2138 drm_scaling_mode_enum_list[i].type,
2139 drm_scaling_mode_enum_list[i].name);
2142 drm_property_destroy(dev, scaling_mode_property);
2148 drm_object_attach_property(&connector->base,
2149 scaling_mode_property, 0);
2151 connector->scaling_mode_property = scaling_mode_property;
2155 EXPORT_SYMBOL(drm_connector_attach_scaling_mode_property);
2158 * drm_mode_create_aspect_ratio_property - create aspect ratio property
2161 * Called by a driver the first time it's needed, must be attached to desired
2165 * Zero on success, negative errno on failure.
2167 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
2169 if (dev->mode_config.aspect_ratio_property)
2172 dev->mode_config.aspect_ratio_property =
2173 drm_property_create_enum(dev, 0, "aspect ratio",
2174 drm_aspect_ratio_enum_list,
2175 ARRAY_SIZE(drm_aspect_ratio_enum_list));
2177 if (dev->mode_config.aspect_ratio_property == NULL)
2182 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
2185 * DOC: standard connector properties
2188 * This property helps select a suitable colorspace based on the sink
2189 * capability. Modern sink devices support wider gamut like BT2020.
2190 * This helps switch to BT2020 mode if the BT2020 encoded video stream
2191 * is being played by the user, same for any other colorspace. Thereby
2192 * giving a good visual experience to users.
2194 * The expectation from userspace is that it should parse the EDID
2195 * and get supported colorspaces. Use this property and switch to the
2196 * one supported. Sink supported colorspaces should be retrieved by
2197 * userspace from EDID and driver will not explicitly expose them.
2199 * Basically the expectation from userspace is:
2200 * - Set up CRTC DEGAMMA/CTM/GAMMA to convert to some sink
2202 * - Set this new property to let the sink know what it
2203 * converted the CRTC output to.
2204 * - This property is just to inform sink what colorspace
2205 * source is trying to drive.
2207 * Because between HDMI and DP have different colorspaces,
2208 * drm_mode_create_hdmi_colorspace_property() is used for HDMI connector and
2209 * drm_mode_create_dp_colorspace_property() is used for DP connector.
2212 static int drm_mode_create_colorspace_property(struct drm_connector *connector,
2213 u32 supported_colorspaces)
2215 struct drm_device *dev = connector->dev;
2216 u32 colorspaces = supported_colorspaces | BIT(DRM_MODE_COLORIMETRY_DEFAULT);
2217 struct drm_prop_enum_list enum_list[DRM_MODE_COLORIMETRY_COUNT];
2220 if (connector->colorspace_property)
2223 if (!supported_colorspaces) {
2224 drm_err(dev, "No supported colorspaces provded on [CONNECTOR:%d:%s]\n",
2225 connector->base.id, connector->name);
2229 if ((supported_colorspaces & -BIT(DRM_MODE_COLORIMETRY_COUNT)) != 0) {
2230 drm_err(dev, "Unknown colorspace provded on [CONNECTOR:%d:%s]\n",
2231 connector->base.id, connector->name);
2236 for (i = 0; i < DRM_MODE_COLORIMETRY_COUNT; i++) {
2237 if ((colorspaces & BIT(i)) == 0)
2240 enum_list[len].type = i;
2241 enum_list[len].name = colorspace_names[i];
2245 connector->colorspace_property =
2246 drm_property_create_enum(dev, DRM_MODE_PROP_ENUM, "Colorspace",
2250 if (!connector->colorspace_property)
2257 * drm_mode_create_hdmi_colorspace_property - create hdmi colorspace property
2258 * @connector: connector to create the Colorspace property on.
2259 * @supported_colorspaces: bitmap of supported color spaces
2261 * Called by a driver the first time it's needed, must be attached to desired
2265 * Zero on success, negative errno on failure.
2267 int drm_mode_create_hdmi_colorspace_property(struct drm_connector *connector,
2268 u32 supported_colorspaces)
2272 if (supported_colorspaces)
2273 colorspaces = supported_colorspaces & hdmi_colorspaces;
2275 colorspaces = hdmi_colorspaces;
2277 return drm_mode_create_colorspace_property(connector, colorspaces);
2279 EXPORT_SYMBOL(drm_mode_create_hdmi_colorspace_property);
2282 * drm_mode_create_dp_colorspace_property - create dp colorspace property
2283 * @connector: connector to create the Colorspace property on.
2284 * @supported_colorspaces: bitmap of supported color spaces
2286 * Called by a driver the first time it's needed, must be attached to desired
2290 * Zero on success, negative errno on failure.
2292 int drm_mode_create_dp_colorspace_property(struct drm_connector *connector,
2293 u32 supported_colorspaces)
2297 if (supported_colorspaces)
2298 colorspaces = supported_colorspaces & dp_colorspaces;
2300 colorspaces = dp_colorspaces;
2302 return drm_mode_create_colorspace_property(connector, colorspaces);
2304 EXPORT_SYMBOL(drm_mode_create_dp_colorspace_property);
2307 * drm_mode_create_content_type_property - create content type property
2310 * Called by a driver the first time it's needed, must be attached to desired
2314 * Zero on success, negative errno on failure.
2316 int drm_mode_create_content_type_property(struct drm_device *dev)
2318 if (dev->mode_config.content_type_property)
2321 dev->mode_config.content_type_property =
2322 drm_property_create_enum(dev, 0, "content type",
2323 drm_content_type_enum_list,
2324 ARRAY_SIZE(drm_content_type_enum_list));
2326 if (dev->mode_config.content_type_property == NULL)
2331 EXPORT_SYMBOL(drm_mode_create_content_type_property);
2334 * drm_mode_create_suggested_offset_properties - create suggests offset properties
2337 * Create the suggested x/y offset property for connectors.
2340 * 0 on success or a negative error code on failure.
2342 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
2344 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
2347 dev->mode_config.suggested_x_property =
2348 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
2350 dev->mode_config.suggested_y_property =
2351 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
2353 if (dev->mode_config.suggested_x_property == NULL ||
2354 dev->mode_config.suggested_y_property == NULL)
2358 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
2361 * drm_connector_set_path_property - set tile property on connector
2362 * @connector: connector to set property on.
2363 * @path: path to use for property; must not be NULL.
2365 * This creates a property to expose to userspace to specify a
2366 * connector path. This is mainly used for DisplayPort MST where
2367 * connectors have a topology and we want to allow userspace to give
2368 * them more meaningful names.
2371 * Zero on success, negative errno on failure.
2373 int drm_connector_set_path_property(struct drm_connector *connector,
2376 struct drm_device *dev = connector->dev;
2379 ret = drm_property_replace_global_blob(dev,
2380 &connector->path_blob_ptr,
2384 dev->mode_config.path_property);
2387 EXPORT_SYMBOL(drm_connector_set_path_property);
2390 * drm_connector_set_tile_property - set tile property on connector
2391 * @connector: connector to set property on.
2393 * This looks up the tile information for a connector, and creates a
2394 * property for userspace to parse if it exists. The property is of
2395 * the form of 8 integers using ':' as a separator.
2396 * This is used for dual port tiled displays with DisplayPort SST
2397 * or DisplayPort MST connectors.
2400 * Zero on success, errno on failure.
2402 int drm_connector_set_tile_property(struct drm_connector *connector)
2404 struct drm_device *dev = connector->dev;
2408 if (!connector->has_tile) {
2409 ret = drm_property_replace_global_blob(dev,
2410 &connector->tile_blob_ptr,
2414 dev->mode_config.tile_property);
2418 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
2419 connector->tile_group->id, connector->tile_is_single_monitor,
2420 connector->num_h_tile, connector->num_v_tile,
2421 connector->tile_h_loc, connector->tile_v_loc,
2422 connector->tile_h_size, connector->tile_v_size);
2424 ret = drm_property_replace_global_blob(dev,
2425 &connector->tile_blob_ptr,
2429 dev->mode_config.tile_property);
2432 EXPORT_SYMBOL(drm_connector_set_tile_property);
2435 * drm_connector_set_link_status_property - Set link status property of a connector
2436 * @connector: drm connector
2437 * @link_status: new value of link status property (0: Good, 1: Bad)
2439 * In usual working scenario, this link status property will always be set to
2440 * "GOOD". If something fails during or after a mode set, the kernel driver
2441 * may set this link status property to "BAD". The caller then needs to send a
2442 * hotplug uevent for userspace to re-check the valid modes through
2443 * GET_CONNECTOR_IOCTL and retry modeset.
2445 * Note: Drivers cannot rely on userspace to support this property and
2446 * issue a modeset. As such, they may choose to handle issues (like
2447 * re-training a link) without userspace's intervention.
2449 * The reason for adding this property is to handle link training failures, but
2450 * it is not limited to DP or link training. For example, if we implement
2451 * asynchronous setcrtc, this property can be used to report any failures in that.
2453 void drm_connector_set_link_status_property(struct drm_connector *connector,
2454 uint64_t link_status)
2456 struct drm_device *dev = connector->dev;
2458 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2459 connector->state->link_status = link_status;
2460 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2462 EXPORT_SYMBOL(drm_connector_set_link_status_property);
2465 * drm_connector_attach_max_bpc_property - attach "max bpc" property
2466 * @connector: connector to attach max bpc property on.
2467 * @min: The minimum bit depth supported by the connector.
2468 * @max: The maximum bit depth supported by the connector.
2470 * This is used to add support for limiting the bit depth on a connector.
2473 * Zero on success, negative errno on failure.
2475 int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
2478 struct drm_device *dev = connector->dev;
2479 struct drm_property *prop;
2481 prop = connector->max_bpc_property;
2483 prop = drm_property_create_range(dev, 0, "max bpc", min, max);
2487 connector->max_bpc_property = prop;
2490 drm_object_attach_property(&connector->base, prop, max);
2491 connector->state->max_requested_bpc = max;
2492 connector->state->max_bpc = max;
2496 EXPORT_SYMBOL(drm_connector_attach_max_bpc_property);
2499 * drm_connector_attach_hdr_output_metadata_property - attach "HDR_OUTPUT_METADA" property
2500 * @connector: connector to attach the property on.
2502 * This is used to allow the userspace to send HDR Metadata to the
2506 * Zero on success, negative errno on failure.
2508 int drm_connector_attach_hdr_output_metadata_property(struct drm_connector *connector)
2510 struct drm_device *dev = connector->dev;
2511 struct drm_property *prop = dev->mode_config.hdr_output_metadata_property;
2513 drm_object_attach_property(&connector->base, prop, 0);
2517 EXPORT_SYMBOL(drm_connector_attach_hdr_output_metadata_property);
2520 * drm_connector_attach_colorspace_property - attach "Colorspace" property
2521 * @connector: connector to attach the property on.
2523 * This is used to allow the userspace to signal the output colorspace
2527 * Zero on success, negative errno on failure.
2529 int drm_connector_attach_colorspace_property(struct drm_connector *connector)
2531 struct drm_property *prop = connector->colorspace_property;
2533 drm_object_attach_property(&connector->base, prop, DRM_MODE_COLORIMETRY_DEFAULT);
2537 EXPORT_SYMBOL(drm_connector_attach_colorspace_property);
2540 * drm_connector_atomic_hdr_metadata_equal - checks if the hdr metadata changed
2541 * @old_state: old connector state to compare
2542 * @new_state: new connector state to compare
2544 * This is used by HDR-enabled drivers to test whether the HDR metadata
2545 * have changed between two different connector state (and thus probably
2546 * requires a full blown mode change).
2549 * True if the metadata are equal, False otherwise
2551 bool drm_connector_atomic_hdr_metadata_equal(struct drm_connector_state *old_state,
2552 struct drm_connector_state *new_state)
2554 struct drm_property_blob *old_blob = old_state->hdr_output_metadata;
2555 struct drm_property_blob *new_blob = new_state->hdr_output_metadata;
2557 if (!old_blob || !new_blob)
2558 return old_blob == new_blob;
2560 if (old_blob->length != new_blob->length)
2563 return !memcmp(old_blob->data, new_blob->data, old_blob->length);
2565 EXPORT_SYMBOL(drm_connector_atomic_hdr_metadata_equal);
2568 * drm_connector_set_vrr_capable_property - sets the variable refresh rate
2569 * capable property for a connector
2570 * @connector: drm connector
2571 * @capable: True if the connector is variable refresh rate capable
2573 * Should be used by atomic drivers to update the indicated support for
2574 * variable refresh rate over a connector.
2576 void drm_connector_set_vrr_capable_property(
2577 struct drm_connector *connector, bool capable)
2579 if (!connector->vrr_capable_property)
2582 drm_object_property_set_value(&connector->base,
2583 connector->vrr_capable_property,
2586 EXPORT_SYMBOL(drm_connector_set_vrr_capable_property);
2589 * drm_connector_set_panel_orientation - sets the connector's panel_orientation
2590 * @connector: connector for which to set the panel-orientation property.
2591 * @panel_orientation: drm_panel_orientation value to set
2593 * This function sets the connector's panel_orientation and attaches
2594 * a "panel orientation" property to the connector.
2596 * Calling this function on a connector where the panel_orientation has
2597 * already been set is a no-op (e.g. the orientation has been overridden with
2598 * a kernel commandline option).
2600 * It is allowed to call this function with a panel_orientation of
2601 * DRM_MODE_PANEL_ORIENTATION_UNKNOWN, in which case it is a no-op.
2603 * The function shouldn't be called in panel after drm is registered (i.e.
2604 * drm_dev_register() is called in drm).
2607 * Zero on success, negative errno on failure.
2609 int drm_connector_set_panel_orientation(
2610 struct drm_connector *connector,
2611 enum drm_panel_orientation panel_orientation)
2613 struct drm_device *dev = connector->dev;
2614 struct drm_display_info *info = &connector->display_info;
2615 struct drm_property *prop;
2618 if (info->panel_orientation != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2621 /* Don't attach the property if the orientation is unknown */
2622 if (panel_orientation == DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2625 info->panel_orientation = panel_orientation;
2627 prop = dev->mode_config.panel_orientation_property;
2629 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
2630 "panel orientation",
2631 drm_panel_orientation_enum_list,
2632 ARRAY_SIZE(drm_panel_orientation_enum_list));
2636 dev->mode_config.panel_orientation_property = prop;
2639 drm_object_attach_property(&connector->base, prop,
2640 info->panel_orientation);
2643 EXPORT_SYMBOL(drm_connector_set_panel_orientation);
2646 * drm_connector_set_panel_orientation_with_quirk - set the
2647 * connector's panel_orientation after checking for quirks
2648 * @connector: connector for which to init the panel-orientation property.
2649 * @panel_orientation: drm_panel_orientation value to set
2650 * @width: width in pixels of the panel, used for panel quirk detection
2651 * @height: height in pixels of the panel, used for panel quirk detection
2653 * Like drm_connector_set_panel_orientation(), but with a check for platform
2654 * specific (e.g. DMI based) quirks overriding the passed in panel_orientation.
2657 * Zero on success, negative errno on failure.
2659 int drm_connector_set_panel_orientation_with_quirk(
2660 struct drm_connector *connector,
2661 enum drm_panel_orientation panel_orientation,
2662 int width, int height)
2664 int orientation_quirk;
2666 orientation_quirk = drm_get_panel_orientation_quirk(width, height);
2667 if (orientation_quirk != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2668 panel_orientation = orientation_quirk;
2670 return drm_connector_set_panel_orientation(connector,
2673 EXPORT_SYMBOL(drm_connector_set_panel_orientation_with_quirk);
2676 * drm_connector_set_orientation_from_panel -
2677 * set the connector's panel_orientation from panel's callback.
2678 * @connector: connector for which to init the panel-orientation property.
2679 * @panel: panel that can provide orientation information.
2681 * Drm drivers should call this function before drm_dev_register().
2682 * Orientation is obtained from panel's .get_orientation() callback.
2685 * Zero on success, negative errno on failure.
2687 int drm_connector_set_orientation_from_panel(
2688 struct drm_connector *connector,
2689 struct drm_panel *panel)
2691 enum drm_panel_orientation orientation;
2693 if (panel && panel->funcs && panel->funcs->get_orientation)
2694 orientation = panel->funcs->get_orientation(panel);
2696 orientation = DRM_MODE_PANEL_ORIENTATION_UNKNOWN;
2698 return drm_connector_set_panel_orientation(connector, orientation);
2700 EXPORT_SYMBOL(drm_connector_set_orientation_from_panel);
2702 static const struct drm_prop_enum_list privacy_screen_enum[] = {
2703 { PRIVACY_SCREEN_DISABLED, "Disabled" },
2704 { PRIVACY_SCREEN_ENABLED, "Enabled" },
2705 { PRIVACY_SCREEN_DISABLED_LOCKED, "Disabled-locked" },
2706 { PRIVACY_SCREEN_ENABLED_LOCKED, "Enabled-locked" },
2710 * drm_connector_create_privacy_screen_properties - create the drm connecter's
2711 * privacy-screen properties.
2712 * @connector: connector for which to create the privacy-screen properties
2714 * This function creates the "privacy-screen sw-state" and "privacy-screen
2715 * hw-state" properties for the connector. They are not attached.
2718 drm_connector_create_privacy_screen_properties(struct drm_connector *connector)
2720 if (connector->privacy_screen_sw_state_property)
2723 /* Note sw-state only supports the first 2 values of the enum */
2724 connector->privacy_screen_sw_state_property =
2725 drm_property_create_enum(connector->dev, DRM_MODE_PROP_ENUM,
2726 "privacy-screen sw-state",
2727 privacy_screen_enum, 2);
2729 connector->privacy_screen_hw_state_property =
2730 drm_property_create_enum(connector->dev,
2731 DRM_MODE_PROP_IMMUTABLE | DRM_MODE_PROP_ENUM,
2732 "privacy-screen hw-state",
2733 privacy_screen_enum,
2734 ARRAY_SIZE(privacy_screen_enum));
2736 EXPORT_SYMBOL(drm_connector_create_privacy_screen_properties);
2739 * drm_connector_attach_privacy_screen_properties - attach the drm connecter's
2740 * privacy-screen properties.
2741 * @connector: connector on which to attach the privacy-screen properties
2743 * This function attaches the "privacy-screen sw-state" and "privacy-screen
2744 * hw-state" properties to the connector. The initial state of both is set
2748 drm_connector_attach_privacy_screen_properties(struct drm_connector *connector)
2750 if (!connector->privacy_screen_sw_state_property)
2753 drm_object_attach_property(&connector->base,
2754 connector->privacy_screen_sw_state_property,
2755 PRIVACY_SCREEN_DISABLED);
2757 drm_object_attach_property(&connector->base,
2758 connector->privacy_screen_hw_state_property,
2759 PRIVACY_SCREEN_DISABLED);
2761 EXPORT_SYMBOL(drm_connector_attach_privacy_screen_properties);
2763 static void drm_connector_update_privacy_screen_properties(
2764 struct drm_connector *connector, bool set_sw_state)
2766 enum drm_privacy_screen_status sw_state, hw_state;
2768 drm_privacy_screen_get_state(connector->privacy_screen,
2769 &sw_state, &hw_state);
2772 connector->state->privacy_screen_sw_state = sw_state;
2773 drm_object_property_set_value(&connector->base,
2774 connector->privacy_screen_hw_state_property, hw_state);
2777 static int drm_connector_privacy_screen_notifier(
2778 struct notifier_block *nb, unsigned long action, void *data)
2780 struct drm_connector *connector =
2781 container_of(nb, struct drm_connector, privacy_screen_notifier);
2782 struct drm_device *dev = connector->dev;
2784 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2785 drm_connector_update_privacy_screen_properties(connector, true);
2786 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2788 drm_sysfs_connector_property_event(connector,
2789 connector->privacy_screen_sw_state_property);
2790 drm_sysfs_connector_property_event(connector,
2791 connector->privacy_screen_hw_state_property);
2797 * drm_connector_attach_privacy_screen_provider - attach a privacy-screen to
2799 * @connector: connector to attach the privacy-screen to
2800 * @priv: drm_privacy_screen to attach
2802 * Create and attach the standard privacy-screen properties and register
2803 * a generic notifier for generating sysfs-connector-status-events
2804 * on external changes to the privacy-screen status.
2805 * This function takes ownership of the passed in drm_privacy_screen and will
2806 * call drm_privacy_screen_put() on it when the connector is destroyed.
2808 void drm_connector_attach_privacy_screen_provider(
2809 struct drm_connector *connector, struct drm_privacy_screen *priv)
2811 connector->privacy_screen = priv;
2812 connector->privacy_screen_notifier.notifier_call =
2813 drm_connector_privacy_screen_notifier;
2815 drm_connector_create_privacy_screen_properties(connector);
2816 drm_connector_update_privacy_screen_properties(connector, true);
2817 drm_connector_attach_privacy_screen_properties(connector);
2819 EXPORT_SYMBOL(drm_connector_attach_privacy_screen_provider);
2822 * drm_connector_update_privacy_screen - update connector's privacy-screen sw-state
2823 * @connector_state: connector-state to update the privacy-screen for
2825 * This function calls drm_privacy_screen_set_sw_state() on the connector's
2828 * If the connector has no privacy-screen, then this is a no-op.
2830 void drm_connector_update_privacy_screen(const struct drm_connector_state *connector_state)
2832 struct drm_connector *connector = connector_state->connector;
2835 if (!connector->privacy_screen)
2838 ret = drm_privacy_screen_set_sw_state(connector->privacy_screen,
2839 connector_state->privacy_screen_sw_state);
2841 drm_err(connector->dev, "Error updating privacy-screen sw_state\n");
2845 /* The hw_state property value may have changed, update it. */
2846 drm_connector_update_privacy_screen_properties(connector, false);
2848 EXPORT_SYMBOL(drm_connector_update_privacy_screen);
2850 int drm_connector_set_obj_prop(struct drm_mode_object *obj,
2851 struct drm_property *property,
2855 struct drm_connector *connector = obj_to_connector(obj);
2857 /* Do DPMS ourselves */
2858 if (property == connector->dev->mode_config.dpms_property) {
2859 ret = (*connector->funcs->dpms)(connector, (int)value);
2860 } else if (connector->funcs->set_property)
2861 ret = connector->funcs->set_property(connector, property, value);
2864 drm_object_property_set_value(&connector->base, property, value);
2868 int drm_connector_property_set_ioctl(struct drm_device *dev,
2869 void *data, struct drm_file *file_priv)
2871 struct drm_mode_connector_set_property *conn_set_prop = data;
2872 struct drm_mode_obj_set_property obj_set_prop = {
2873 .value = conn_set_prop->value,
2874 .prop_id = conn_set_prop->prop_id,
2875 .obj_id = conn_set_prop->connector_id,
2876 .obj_type = DRM_MODE_OBJECT_CONNECTOR
2879 /* It does all the locking and checking we need */
2880 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
2883 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
2885 /* For atomic drivers only state objects are synchronously updated and
2886 * protected by modeset locks, so check those first.
2888 if (connector->state)
2889 return connector->state->best_encoder;
2890 return connector->encoder;
2894 drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
2895 const struct list_head *modes,
2896 const struct drm_file *file_priv)
2899 * If user-space hasn't configured the driver to expose the stereo 3D
2900 * modes, don't expose them.
2902 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
2905 * If user-space hasn't configured the driver to expose the modes
2906 * with aspect-ratio, don't expose them. However if such a mode
2907 * is unique, let it be exposed, but reset the aspect-ratio flags
2908 * while preparing the list of user-modes.
2910 if (!file_priv->aspect_ratio_allowed) {
2911 const struct drm_display_mode *mode_itr;
2913 list_for_each_entry(mode_itr, modes, head) {
2914 if (mode_itr->expose_to_userspace &&
2915 drm_mode_match(mode_itr, mode,
2916 DRM_MODE_MATCH_TIMINGS |
2917 DRM_MODE_MATCH_CLOCK |
2918 DRM_MODE_MATCH_FLAGS |
2919 DRM_MODE_MATCH_3D_FLAGS))
2927 int drm_mode_getconnector(struct drm_device *dev, void *data,
2928 struct drm_file *file_priv)
2930 struct drm_mode_get_connector *out_resp = data;
2931 struct drm_connector *connector;
2932 struct drm_encoder *encoder;
2933 struct drm_display_mode *mode;
2935 int encoders_count = 0;
2938 struct drm_mode_modeinfo u_mode;
2939 struct drm_mode_modeinfo __user *mode_ptr;
2940 uint32_t __user *encoder_ptr;
2941 bool is_current_master;
2943 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2946 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2948 connector = drm_connector_lookup(dev, file_priv, out_resp->connector_id);
2952 encoders_count = hweight32(connector->possible_encoders);
2954 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2956 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2958 drm_connector_for_each_possible_encoder(connector, encoder) {
2959 if (put_user(encoder->base.id, encoder_ptr + copied)) {
2966 out_resp->count_encoders = encoders_count;
2968 out_resp->connector_id = connector->base.id;
2969 out_resp->connector_type = connector->connector_type;
2970 out_resp->connector_type_id = connector->connector_type_id;
2972 is_current_master = drm_is_current_master(file_priv);
2974 mutex_lock(&dev->mode_config.mutex);
2975 if (out_resp->count_modes == 0) {
2976 if (is_current_master)
2977 connector->funcs->fill_modes(connector,
2978 dev->mode_config.max_width,
2979 dev->mode_config.max_height);
2981 drm_dbg_kms(dev, "User-space requested a forced probe on [CONNECTOR:%d:%s] but is not the DRM master, demoting to read-only probe",
2982 connector->base.id, connector->name);
2985 out_resp->mm_width = connector->display_info.width_mm;
2986 out_resp->mm_height = connector->display_info.height_mm;
2987 out_resp->subpixel = connector->display_info.subpixel_order;
2988 out_resp->connection = connector->status;
2990 /* delayed so we get modes regardless of pre-fill_modes state */
2991 list_for_each_entry(mode, &connector->modes, head) {
2992 WARN_ON(mode->expose_to_userspace);
2994 if (drm_mode_expose_to_userspace(mode, &connector->modes,
2996 mode->expose_to_userspace = true;
3002 * This ioctl is called twice, once to determine how much space is
3003 * needed, and the 2nd time to fill it.
3005 if ((out_resp->count_modes >= mode_count) && mode_count) {
3007 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
3008 list_for_each_entry(mode, &connector->modes, head) {
3009 if (!mode->expose_to_userspace)
3012 /* Clear the tag for the next time around */
3013 mode->expose_to_userspace = false;
3015 drm_mode_convert_to_umode(&u_mode, mode);
3017 * Reset aspect ratio flags of user-mode, if modes with
3018 * aspect-ratio are not supported.
3020 if (!file_priv->aspect_ratio_allowed)
3021 u_mode.flags &= ~DRM_MODE_FLAG_PIC_AR_MASK;
3022 if (copy_to_user(mode_ptr + copied,
3023 &u_mode, sizeof(u_mode))) {
3027 * Clear the tag for the rest of
3028 * the modes for the next time around.
3030 list_for_each_entry_continue(mode, &connector->modes, head)
3031 mode->expose_to_userspace = false;
3033 mutex_unlock(&dev->mode_config.mutex);
3040 /* Clear the tag for the next time around */
3041 list_for_each_entry(mode, &connector->modes, head)
3042 mode->expose_to_userspace = false;
3045 out_resp->count_modes = mode_count;
3046 mutex_unlock(&dev->mode_config.mutex);
3048 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
3049 encoder = drm_connector_get_encoder(connector);
3051 out_resp->encoder_id = encoder->base.id;
3053 out_resp->encoder_id = 0;
3055 /* Only grab properties after probing, to make sure EDID and other
3056 * properties reflect the latest status.
3058 ret = drm_mode_object_get_properties(&connector->base, file_priv->atomic,
3059 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
3060 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
3061 &out_resp->count_props);
3062 drm_modeset_unlock(&dev->mode_config.connection_mutex);
3065 drm_connector_put(connector);
3071 * drm_connector_find_by_fwnode - Find a connector based on the associated fwnode
3072 * @fwnode: fwnode for which to find the matching drm_connector
3074 * This functions looks up a drm_connector based on its associated fwnode. When
3075 * a connector is found a reference to the connector is returned. The caller must
3076 * call drm_connector_put() to release this reference when it is done with the
3079 * Returns: A reference to the found connector or an ERR_PTR().
3081 struct drm_connector *drm_connector_find_by_fwnode(struct fwnode_handle *fwnode)
3083 struct drm_connector *connector, *found = ERR_PTR(-ENODEV);
3086 return ERR_PTR(-ENODEV);
3088 mutex_lock(&connector_list_lock);
3090 list_for_each_entry(connector, &connector_list, global_connector_list_entry) {
3091 if (connector->fwnode == fwnode ||
3092 (connector->fwnode && connector->fwnode->secondary == fwnode)) {
3093 drm_connector_get(connector);
3099 mutex_unlock(&connector_list_lock);
3105 * drm_connector_oob_hotplug_event - Report out-of-band hotplug event to connector
3106 * @connector_fwnode: fwnode_handle to report the event on
3108 * On some hardware a hotplug event notification may come from outside the display
3109 * driver / device. An example of this is some USB Type-C setups where the hardware
3110 * muxes the DisplayPort data and aux-lines but does not pass the altmode HPD
3111 * status bit to the GPU's DP HPD pin.
3113 * This function can be used to report these out-of-band events after obtaining
3114 * a drm_connector reference through calling drm_connector_find_by_fwnode().
3116 void drm_connector_oob_hotplug_event(struct fwnode_handle *connector_fwnode)
3118 struct drm_connector *connector;
3120 connector = drm_connector_find_by_fwnode(connector_fwnode);
3121 if (IS_ERR(connector))
3124 if (connector->funcs->oob_hotplug_event)
3125 connector->funcs->oob_hotplug_event(connector);
3127 drm_connector_put(connector);
3129 EXPORT_SYMBOL(drm_connector_oob_hotplug_event);
3135 * Tile groups are used to represent tiled monitors with a unique integer
3136 * identifier. Tiled monitors using DisplayID v1.3 have a unique 8-byte handle,
3137 * we store this in a tile group, so we have a common identifier for all tiles
3138 * in a monitor group. The property is called "TILE". Drivers can manage tile
3139 * groups using drm_mode_create_tile_group(), drm_mode_put_tile_group() and
3140 * drm_mode_get_tile_group(). But this is only needed for internal panels where
3141 * the tile group information is exposed through a non-standard way.
3144 static void drm_tile_group_free(struct kref *kref)
3146 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
3147 struct drm_device *dev = tg->dev;
3149 mutex_lock(&dev->mode_config.idr_mutex);
3150 idr_remove(&dev->mode_config.tile_idr, tg->id);
3151 mutex_unlock(&dev->mode_config.idr_mutex);
3156 * drm_mode_put_tile_group - drop a reference to a tile group.
3158 * @tg: tile group to drop reference to.
3160 * drop reference to tile group and free if 0.
3162 void drm_mode_put_tile_group(struct drm_device *dev,
3163 struct drm_tile_group *tg)
3165 kref_put(&tg->refcount, drm_tile_group_free);
3167 EXPORT_SYMBOL(drm_mode_put_tile_group);
3170 * drm_mode_get_tile_group - get a reference to an existing tile group
3172 * @topology: 8-bytes unique per monitor.
3174 * Use the unique bytes to get a reference to an existing tile group.
3177 * tile group or NULL if not found.
3179 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
3180 const char topology[8])
3182 struct drm_tile_group *tg;
3185 mutex_lock(&dev->mode_config.idr_mutex);
3186 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
3187 if (!memcmp(tg->group_data, topology, 8)) {
3188 if (!kref_get_unless_zero(&tg->refcount))
3190 mutex_unlock(&dev->mode_config.idr_mutex);
3194 mutex_unlock(&dev->mode_config.idr_mutex);
3197 EXPORT_SYMBOL(drm_mode_get_tile_group);
3200 * drm_mode_create_tile_group - create a tile group from a displayid description
3202 * @topology: 8-bytes unique per monitor.
3204 * Create a tile group for the unique monitor, and get a unique
3205 * identifier for the tile group.
3208 * new tile group or NULL.
3210 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
3211 const char topology[8])
3213 struct drm_tile_group *tg;
3216 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
3220 kref_init(&tg->refcount);
3221 memcpy(tg->group_data, topology, 8);
3224 mutex_lock(&dev->mode_config.idr_mutex);
3225 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
3233 mutex_unlock(&dev->mode_config.idr_mutex);
3236 EXPORT_SYMBOL(drm_mode_create_tile_group);