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_print.h>
31 #include <drm/drm_sysfs.h>
32 #include <drm/drm_utils.h>
34 #include <linux/uaccess.h>
36 #include "drm_crtc_internal.h"
37 #include "drm_internal.h"
42 * In DRM connectors are the general abstraction for display sinks, and include
43 * also fixed panels or anything else that can display pixels in some form. As
44 * opposed to all other KMS objects representing hardware (like CRTC, encoder or
45 * plane abstractions) connectors can be hotplugged and unplugged at runtime.
46 * Hence they are reference-counted using drm_connector_get() and
47 * drm_connector_put().
49 * KMS driver must create, initialize, register and attach at a &struct
50 * drm_connector for each such sink. The instance is created as other KMS
51 * objects and initialized by setting the following fields. The connector is
52 * initialized with a call to drm_connector_init() with a pointer to the
53 * &struct drm_connector_funcs and a connector type, and then exposed to
54 * userspace with a call to drm_connector_register().
56 * Connectors must be attached to an encoder to be used. For devices that map
57 * connectors to encoders 1:1, the connector should be attached at
58 * initialization time with a call to drm_connector_attach_encoder(). The
59 * driver must also set the &drm_connector.encoder field to point to the
62 * For connectors which are not fixed (like built-in panels) the driver needs to
63 * support hotplug notifications. The simplest way to do that is by using the
64 * probe helpers, see drm_kms_helper_poll_init() for connectors which don't have
65 * hardware support for hotplug interrupts. Connectors with hardware hotplug
66 * support can instead use e.g. drm_helper_hpd_irq_event().
69 struct drm_conn_prop_enum_list {
76 * Connector and encoder types.
78 static struct drm_conn_prop_enum_list drm_connector_enum_list[] = {
79 { DRM_MODE_CONNECTOR_Unknown, "Unknown" },
80 { DRM_MODE_CONNECTOR_VGA, "VGA" },
81 { DRM_MODE_CONNECTOR_DVII, "DVI-I" },
82 { DRM_MODE_CONNECTOR_DVID, "DVI-D" },
83 { DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
84 { DRM_MODE_CONNECTOR_Composite, "Composite" },
85 { DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
86 { DRM_MODE_CONNECTOR_LVDS, "LVDS" },
87 { DRM_MODE_CONNECTOR_Component, "Component" },
88 { DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
89 { DRM_MODE_CONNECTOR_DisplayPort, "DP" },
90 { DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
91 { DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
92 { DRM_MODE_CONNECTOR_TV, "TV" },
93 { DRM_MODE_CONNECTOR_eDP, "eDP" },
94 { DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
95 { DRM_MODE_CONNECTOR_DSI, "DSI" },
96 { DRM_MODE_CONNECTOR_DPI, "DPI" },
97 { DRM_MODE_CONNECTOR_WRITEBACK, "Writeback" },
98 { DRM_MODE_CONNECTOR_SPI, "SPI" },
99 { DRM_MODE_CONNECTOR_USB, "USB" },
102 void drm_connector_ida_init(void)
106 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
107 ida_init(&drm_connector_enum_list[i].ida);
110 void drm_connector_ida_destroy(void)
114 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
115 ida_destroy(&drm_connector_enum_list[i].ida);
119 * drm_get_connector_type_name - return a string for connector type
120 * @type: The connector type (DRM_MODE_CONNECTOR_*)
122 * Returns: the name of the connector type, or NULL if the type is not valid.
124 const char *drm_get_connector_type_name(unsigned int type)
126 if (type < ARRAY_SIZE(drm_connector_enum_list))
127 return drm_connector_enum_list[type].name;
131 EXPORT_SYMBOL(drm_get_connector_type_name);
134 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
135 * @connector: connector to query
137 * The kernel supports per-connector configuration of its consoles through
138 * use of the video= parameter. This function parses that option and
139 * extracts the user's specified mode (or enable/disable status) for a
140 * particular connector. This is typically only used during the early fbdev
143 static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
145 struct drm_cmdline_mode *mode = &connector->cmdline_mode;
148 if (fb_get_options(connector->name, &option))
151 if (!drm_mode_parse_command_line_for_connector(option,
157 DRM_INFO("forcing %s connector %s\n", connector->name,
158 drm_get_connector_force_name(mode->force));
159 connector->force = mode->force;
162 if (mode->panel_orientation != DRM_MODE_PANEL_ORIENTATION_UNKNOWN) {
163 DRM_INFO("cmdline forces connector %s panel_orientation to %d\n",
164 connector->name, mode->panel_orientation);
165 drm_connector_set_panel_orientation(connector,
166 mode->panel_orientation);
169 DRM_DEBUG_KMS("cmdline mode for connector %s %s %dx%d@%dHz%s%s%s\n",
170 connector->name, mode->name,
171 mode->xres, mode->yres,
172 mode->refresh_specified ? mode->refresh : 60,
173 mode->rb ? " reduced blanking" : "",
174 mode->margins ? " with margins" : "",
175 mode->interlace ? " interlaced" : "");
178 static void drm_connector_free(struct kref *kref)
180 struct drm_connector *connector =
181 container_of(kref, struct drm_connector, base.refcount);
182 struct drm_device *dev = connector->dev;
184 drm_mode_object_unregister(dev, &connector->base);
185 connector->funcs->destroy(connector);
188 void drm_connector_free_work_fn(struct work_struct *work)
190 struct drm_connector *connector, *n;
191 struct drm_device *dev =
192 container_of(work, struct drm_device, mode_config.connector_free_work);
193 struct drm_mode_config *config = &dev->mode_config;
195 struct llist_node *freed;
197 spin_lock_irqsave(&config->connector_list_lock, flags);
198 freed = llist_del_all(&config->connector_free_list);
199 spin_unlock_irqrestore(&config->connector_list_lock, flags);
201 llist_for_each_entry_safe(connector, n, freed, free_node) {
202 drm_mode_object_unregister(dev, &connector->base);
203 connector->funcs->destroy(connector);
207 static int __drm_connector_init(struct drm_device *dev,
208 struct drm_connector *connector,
209 const struct drm_connector_funcs *funcs,
211 struct i2c_adapter *ddc)
213 struct drm_mode_config *config = &dev->mode_config;
215 struct ida *connector_ida =
216 &drm_connector_enum_list[connector_type].ida;
218 WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
219 (!funcs->atomic_destroy_state ||
220 !funcs->atomic_duplicate_state));
222 ret = __drm_mode_object_add(dev, &connector->base,
223 DRM_MODE_OBJECT_CONNECTOR,
224 false, drm_connector_free);
228 connector->base.properties = &connector->properties;
229 connector->dev = dev;
230 connector->funcs = funcs;
232 /* connector index is used with 32bit bitmasks */
233 ret = ida_simple_get(&config->connector_ida, 0, 32, GFP_KERNEL);
235 DRM_DEBUG_KMS("Failed to allocate %s connector index: %d\n",
236 drm_connector_enum_list[connector_type].name,
240 connector->index = ret;
243 connector->connector_type = connector_type;
244 connector->connector_type_id =
245 ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
246 if (connector->connector_type_id < 0) {
247 ret = connector->connector_type_id;
251 kasprintf(GFP_KERNEL, "%s-%d",
252 drm_connector_enum_list[connector_type].name,
253 connector->connector_type_id);
254 if (!connector->name) {
256 goto out_put_type_id;
259 INIT_LIST_HEAD(&connector->probed_modes);
260 INIT_LIST_HEAD(&connector->modes);
261 mutex_init(&connector->mutex);
262 /* provide ddc symlink in sysfs */
263 connector->ddc = ddc;
264 connector->edid_blob_ptr = NULL;
265 connector->epoch_counter = 0;
266 connector->tile_blob_ptr = NULL;
267 connector->status = connector_status_unknown;
268 connector->display_info.panel_orientation =
269 DRM_MODE_PANEL_ORIENTATION_UNKNOWN;
271 drm_connector_get_cmdline_mode(connector);
273 /* We should add connectors at the end to avoid upsetting the connector
276 spin_lock_irq(&config->connector_list_lock);
277 list_add_tail(&connector->head, &config->connector_list);
278 config->num_connector++;
279 spin_unlock_irq(&config->connector_list_lock);
281 if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL &&
282 connector_type != DRM_MODE_CONNECTOR_WRITEBACK)
283 drm_connector_attach_edid_property(connector);
285 drm_object_attach_property(&connector->base,
286 config->dpms_property, 0);
288 drm_object_attach_property(&connector->base,
289 config->link_status_property,
292 drm_object_attach_property(&connector->base,
293 config->non_desktop_property,
295 drm_object_attach_property(&connector->base,
296 config->tile_property,
299 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
300 drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
303 connector->debugfs_entry = NULL;
306 ida_simple_remove(connector_ida, connector->connector_type_id);
309 ida_simple_remove(&config->connector_ida, connector->index);
312 drm_mode_object_unregister(dev, &connector->base);
318 * drm_connector_init - Init a preallocated connector
320 * @connector: the connector to init
321 * @funcs: callbacks for this connector
322 * @connector_type: user visible type of the connector
324 * Initialises a preallocated connector. Connectors should be
325 * subclassed as part of driver connector objects.
327 * At driver unload time the driver's &drm_connector_funcs.destroy hook
328 * should call drm_connector_cleanup() and free the connector structure.
329 * The connector structure should not be allocated with devm_kzalloc().
331 * Note: consider using drmm_connector_init() instead of
332 * drm_connector_init() to let the DRM managed resource infrastructure
333 * take care of cleanup and deallocation.
336 * Zero on success, error code on failure.
338 int drm_connector_init(struct drm_device *dev,
339 struct drm_connector *connector,
340 const struct drm_connector_funcs *funcs,
343 if (drm_WARN_ON(dev, !(funcs && funcs->destroy)))
346 return __drm_connector_init(dev, connector, funcs, connector_type, NULL);
348 EXPORT_SYMBOL(drm_connector_init);
351 * drm_connector_init_with_ddc - Init a preallocated connector
353 * @connector: the connector to init
354 * @funcs: callbacks for this connector
355 * @connector_type: user visible type of the connector
356 * @ddc: pointer to the associated ddc adapter
358 * Initialises a preallocated connector. Connectors should be
359 * subclassed as part of driver connector objects.
361 * At driver unload time the driver's &drm_connector_funcs.destroy hook
362 * should call drm_connector_cleanup() and free the connector structure.
363 * The connector structure should not be allocated with devm_kzalloc().
365 * Ensures that the ddc field of the connector is correctly set.
367 * Note: consider using drmm_connector_init() instead of
368 * drm_connector_init_with_ddc() to let the DRM managed resource
369 * infrastructure take care of cleanup and deallocation.
372 * Zero on success, error code on failure.
374 int drm_connector_init_with_ddc(struct drm_device *dev,
375 struct drm_connector *connector,
376 const struct drm_connector_funcs *funcs,
378 struct i2c_adapter *ddc)
380 if (drm_WARN_ON(dev, !(funcs && funcs->destroy)))
383 return __drm_connector_init(dev, connector, funcs, connector_type, ddc);
385 EXPORT_SYMBOL(drm_connector_init_with_ddc);
387 static void drm_connector_cleanup_action(struct drm_device *dev,
390 struct drm_connector *connector = ptr;
392 drm_connector_cleanup(connector);
396 * drmm_connector_init - Init a preallocated connector
398 * @connector: the connector to init
399 * @funcs: callbacks for this connector
400 * @connector_type: user visible type of the connector
401 * @ddc: optional pointer to the associated ddc adapter
403 * Initialises a preallocated connector. Connectors should be
404 * subclassed as part of driver connector objects.
406 * Cleanup is automatically handled with a call to
407 * drm_connector_cleanup() in a DRM-managed action.
409 * The connector structure should be allocated with drmm_kzalloc().
412 * Zero on success, error code on failure.
414 int drmm_connector_init(struct drm_device *dev,
415 struct drm_connector *connector,
416 const struct drm_connector_funcs *funcs,
418 struct i2c_adapter *ddc)
422 if (drm_WARN_ON(dev, funcs && funcs->destroy))
425 ret = __drm_connector_init(dev, connector, funcs, connector_type, ddc);
429 ret = drmm_add_action_or_reset(dev, drm_connector_cleanup_action,
436 EXPORT_SYMBOL(drmm_connector_init);
439 * drm_connector_attach_edid_property - attach edid property.
440 * @connector: the connector
442 * Some connector types like DRM_MODE_CONNECTOR_VIRTUAL do not get a
443 * edid property attached by default. This function can be used to
444 * explicitly enable the edid property in these cases.
446 void drm_connector_attach_edid_property(struct drm_connector *connector)
448 struct drm_mode_config *config = &connector->dev->mode_config;
450 drm_object_attach_property(&connector->base,
451 config->edid_property,
454 EXPORT_SYMBOL(drm_connector_attach_edid_property);
457 * drm_connector_attach_encoder - attach a connector to an encoder
458 * @connector: connector to attach
459 * @encoder: encoder to attach @connector to
461 * This function links up a connector to an encoder. Note that the routing
462 * restrictions between encoders and crtcs are exposed to userspace through the
463 * possible_clones and possible_crtcs bitmasks.
466 * Zero on success, negative errno on failure.
468 int drm_connector_attach_encoder(struct drm_connector *connector,
469 struct drm_encoder *encoder)
472 * In the past, drivers have attempted to model the static association
473 * of connector to encoder in simple connector/encoder devices using a
474 * direct assignment of connector->encoder = encoder. This connection
475 * is a logical one and the responsibility of the core, so drivers are
476 * expected not to mess with this.
478 * Note that the error return should've been enough here, but a large
479 * majority of drivers ignores the return value, so add in a big WARN
480 * to get people's attention.
482 if (WARN_ON(connector->encoder))
485 connector->possible_encoders |= drm_encoder_mask(encoder);
489 EXPORT_SYMBOL(drm_connector_attach_encoder);
492 * drm_connector_has_possible_encoder - check if the connector and encoder are
493 * associated with each other
494 * @connector: the connector
495 * @encoder: the encoder
498 * True if @encoder is one of the possible encoders for @connector.
500 bool drm_connector_has_possible_encoder(struct drm_connector *connector,
501 struct drm_encoder *encoder)
503 return connector->possible_encoders & drm_encoder_mask(encoder);
505 EXPORT_SYMBOL(drm_connector_has_possible_encoder);
507 static void drm_mode_remove(struct drm_connector *connector,
508 struct drm_display_mode *mode)
510 list_del(&mode->head);
511 drm_mode_destroy(connector->dev, mode);
515 * drm_connector_cleanup - cleans up an initialised connector
516 * @connector: connector to cleanup
518 * Cleans up the connector but doesn't free the object.
520 void drm_connector_cleanup(struct drm_connector *connector)
522 struct drm_device *dev = connector->dev;
523 struct drm_display_mode *mode, *t;
525 /* The connector should have been removed from userspace long before
526 * it is finally destroyed.
528 if (WARN_ON(connector->registration_state ==
529 DRM_CONNECTOR_REGISTERED))
530 drm_connector_unregister(connector);
532 if (connector->tile_group) {
533 drm_mode_put_tile_group(dev, connector->tile_group);
534 connector->tile_group = NULL;
537 list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
538 drm_mode_remove(connector, mode);
540 list_for_each_entry_safe(mode, t, &connector->modes, head)
541 drm_mode_remove(connector, mode);
543 ida_simple_remove(&drm_connector_enum_list[connector->connector_type].ida,
544 connector->connector_type_id);
546 ida_simple_remove(&dev->mode_config.connector_ida,
549 kfree(connector->display_info.bus_formats);
550 drm_mode_object_unregister(dev, &connector->base);
551 kfree(connector->name);
552 connector->name = NULL;
553 spin_lock_irq(&dev->mode_config.connector_list_lock);
554 list_del(&connector->head);
555 dev->mode_config.num_connector--;
556 spin_unlock_irq(&dev->mode_config.connector_list_lock);
558 WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
559 if (connector->state && connector->funcs->atomic_destroy_state)
560 connector->funcs->atomic_destroy_state(connector,
563 mutex_destroy(&connector->mutex);
565 memset(connector, 0, sizeof(*connector));
568 drm_sysfs_hotplug_event(dev);
570 EXPORT_SYMBOL(drm_connector_cleanup);
573 * drm_connector_register - register a connector
574 * @connector: the connector to register
576 * Register userspace interfaces for a connector. Only call this for connectors
577 * which can be hotplugged after drm_dev_register() has been called already,
578 * e.g. DP MST connectors. All other connectors will be registered automatically
579 * when calling drm_dev_register().
581 * When the connector is no longer available, callers must call
582 * drm_connector_unregister().
585 * Zero on success, error code on failure.
587 int drm_connector_register(struct drm_connector *connector)
591 if (!connector->dev->registered)
594 mutex_lock(&connector->mutex);
595 if (connector->registration_state != DRM_CONNECTOR_INITIALIZING)
598 ret = drm_sysfs_connector_add(connector);
602 drm_debugfs_connector_add(connector);
604 if (connector->funcs->late_register) {
605 ret = connector->funcs->late_register(connector);
610 drm_mode_object_register(connector->dev, &connector->base);
612 connector->registration_state = DRM_CONNECTOR_REGISTERED;
614 /* Let userspace know we have a new connector */
615 drm_sysfs_hotplug_event(connector->dev);
620 drm_debugfs_connector_remove(connector);
621 drm_sysfs_connector_remove(connector);
623 mutex_unlock(&connector->mutex);
626 EXPORT_SYMBOL(drm_connector_register);
629 * drm_connector_unregister - unregister a connector
630 * @connector: the connector to unregister
632 * Unregister userspace interfaces for a connector. Only call this for
633 * connectors which have been registered explicitly by calling
634 * drm_connector_register().
636 void drm_connector_unregister(struct drm_connector *connector)
638 mutex_lock(&connector->mutex);
639 if (connector->registration_state != DRM_CONNECTOR_REGISTERED) {
640 mutex_unlock(&connector->mutex);
644 if (connector->funcs->early_unregister)
645 connector->funcs->early_unregister(connector);
647 drm_sysfs_connector_remove(connector);
648 drm_debugfs_connector_remove(connector);
650 connector->registration_state = DRM_CONNECTOR_UNREGISTERED;
651 mutex_unlock(&connector->mutex);
653 EXPORT_SYMBOL(drm_connector_unregister);
655 void drm_connector_unregister_all(struct drm_device *dev)
657 struct drm_connector *connector;
658 struct drm_connector_list_iter conn_iter;
660 drm_connector_list_iter_begin(dev, &conn_iter);
661 drm_for_each_connector_iter(connector, &conn_iter)
662 drm_connector_unregister(connector);
663 drm_connector_list_iter_end(&conn_iter);
666 int drm_connector_register_all(struct drm_device *dev)
668 struct drm_connector *connector;
669 struct drm_connector_list_iter conn_iter;
672 drm_connector_list_iter_begin(dev, &conn_iter);
673 drm_for_each_connector_iter(connector, &conn_iter) {
674 ret = drm_connector_register(connector);
678 drm_connector_list_iter_end(&conn_iter);
681 drm_connector_unregister_all(dev);
686 * drm_get_connector_status_name - return a string for connector status
687 * @status: connector status to compute name of
689 * In contrast to the other drm_get_*_name functions this one here returns a
690 * const pointer and hence is threadsafe.
692 const char *drm_get_connector_status_name(enum drm_connector_status status)
694 if (status == connector_status_connected)
696 else if (status == connector_status_disconnected)
697 return "disconnected";
701 EXPORT_SYMBOL(drm_get_connector_status_name);
704 * drm_get_connector_force_name - return a string for connector force
705 * @force: connector force to get name of
707 * Returns: const pointer to name.
709 const char *drm_get_connector_force_name(enum drm_connector_force force)
712 case DRM_FORCE_UNSPECIFIED:
713 return "unspecified";
718 case DRM_FORCE_ON_DIGITAL:
725 #ifdef CONFIG_LOCKDEP
726 static struct lockdep_map connector_list_iter_dep_map = {
727 .name = "drm_connector_list_iter"
732 * drm_connector_list_iter_begin - initialize a connector_list iterator
734 * @iter: connector_list iterator
736 * Sets @iter up to walk the &drm_mode_config.connector_list of @dev. @iter
737 * must always be cleaned up again by calling drm_connector_list_iter_end().
738 * Iteration itself happens using drm_connector_list_iter_next() or
739 * drm_for_each_connector_iter().
741 void drm_connector_list_iter_begin(struct drm_device *dev,
742 struct drm_connector_list_iter *iter)
746 lock_acquire_shared_recursive(&connector_list_iter_dep_map, 0, 1, NULL, _RET_IP_);
748 EXPORT_SYMBOL(drm_connector_list_iter_begin);
751 * Extra-safe connector put function that works in any context. Should only be
752 * used from the connector_iter functions, where we never really expect to
753 * actually release the connector when dropping our final reference.
756 __drm_connector_put_safe(struct drm_connector *conn)
758 struct drm_mode_config *config = &conn->dev->mode_config;
760 lockdep_assert_held(&config->connector_list_lock);
762 if (!refcount_dec_and_test(&conn->base.refcount.refcount))
765 llist_add(&conn->free_node, &config->connector_free_list);
766 schedule_work(&config->connector_free_work);
770 * drm_connector_list_iter_next - return next connector
771 * @iter: connector_list iterator
773 * Returns the next connector for @iter, or NULL when the list walk has
776 struct drm_connector *
777 drm_connector_list_iter_next(struct drm_connector_list_iter *iter)
779 struct drm_connector *old_conn = iter->conn;
780 struct drm_mode_config *config = &iter->dev->mode_config;
781 struct list_head *lhead;
784 spin_lock_irqsave(&config->connector_list_lock, flags);
785 lhead = old_conn ? &old_conn->head : &config->connector_list;
788 if (lhead->next == &config->connector_list) {
794 iter->conn = list_entry(lhead, struct drm_connector, head);
796 /* loop until it's not a zombie connector */
797 } while (!kref_get_unless_zero(&iter->conn->base.refcount));
800 __drm_connector_put_safe(old_conn);
801 spin_unlock_irqrestore(&config->connector_list_lock, flags);
805 EXPORT_SYMBOL(drm_connector_list_iter_next);
808 * drm_connector_list_iter_end - tear down a connector_list iterator
809 * @iter: connector_list iterator
811 * Tears down @iter and releases any resources (like &drm_connector references)
812 * acquired while walking the list. This must always be called, both when the
813 * iteration completes fully or when it was aborted without walking the entire
816 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter)
818 struct drm_mode_config *config = &iter->dev->mode_config;
823 spin_lock_irqsave(&config->connector_list_lock, flags);
824 __drm_connector_put_safe(iter->conn);
825 spin_unlock_irqrestore(&config->connector_list_lock, flags);
827 lock_release(&connector_list_iter_dep_map, _RET_IP_);
829 EXPORT_SYMBOL(drm_connector_list_iter_end);
831 static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
832 { SubPixelUnknown, "Unknown" },
833 { SubPixelHorizontalRGB, "Horizontal RGB" },
834 { SubPixelHorizontalBGR, "Horizontal BGR" },
835 { SubPixelVerticalRGB, "Vertical RGB" },
836 { SubPixelVerticalBGR, "Vertical BGR" },
837 { SubPixelNone, "None" },
841 * drm_get_subpixel_order_name - return a string for a given subpixel enum
842 * @order: enum of subpixel_order
844 * Note you could abuse this and return something out of bounds, but that
845 * would be a caller error. No unscrubbed user data should make it here.
847 const char *drm_get_subpixel_order_name(enum subpixel_order order)
849 return drm_subpixel_enum_list[order].name;
851 EXPORT_SYMBOL(drm_get_subpixel_order_name);
853 static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
854 { DRM_MODE_DPMS_ON, "On" },
855 { DRM_MODE_DPMS_STANDBY, "Standby" },
856 { DRM_MODE_DPMS_SUSPEND, "Suspend" },
857 { DRM_MODE_DPMS_OFF, "Off" }
859 DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
861 static const struct drm_prop_enum_list drm_link_status_enum_list[] = {
862 { DRM_MODE_LINK_STATUS_GOOD, "Good" },
863 { DRM_MODE_LINK_STATUS_BAD, "Bad" },
867 * drm_display_info_set_bus_formats - set the supported bus formats
868 * @info: display info to store bus formats in
869 * @formats: array containing the supported bus formats
870 * @num_formats: the number of entries in the fmts array
872 * Store the supported bus formats in display info structure.
873 * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
874 * a full list of available formats.
876 int drm_display_info_set_bus_formats(struct drm_display_info *info,
878 unsigned int num_formats)
882 if (!formats && num_formats)
885 if (formats && num_formats) {
886 fmts = kmemdup(formats, sizeof(*formats) * num_formats,
892 kfree(info->bus_formats);
893 info->bus_formats = fmts;
894 info->num_bus_formats = num_formats;
898 EXPORT_SYMBOL(drm_display_info_set_bus_formats);
900 /* Optional connector properties. */
901 static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
902 { DRM_MODE_SCALE_NONE, "None" },
903 { DRM_MODE_SCALE_FULLSCREEN, "Full" },
904 { DRM_MODE_SCALE_CENTER, "Center" },
905 { DRM_MODE_SCALE_ASPECT, "Full aspect" },
908 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
909 { DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
910 { DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
911 { DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
914 static const struct drm_prop_enum_list drm_content_type_enum_list[] = {
915 { DRM_MODE_CONTENT_TYPE_NO_DATA, "No Data" },
916 { DRM_MODE_CONTENT_TYPE_GRAPHICS, "Graphics" },
917 { DRM_MODE_CONTENT_TYPE_PHOTO, "Photo" },
918 { DRM_MODE_CONTENT_TYPE_CINEMA, "Cinema" },
919 { DRM_MODE_CONTENT_TYPE_GAME, "Game" },
922 static const struct drm_prop_enum_list drm_panel_orientation_enum_list[] = {
923 { DRM_MODE_PANEL_ORIENTATION_NORMAL, "Normal" },
924 { DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP, "Upside Down" },
925 { DRM_MODE_PANEL_ORIENTATION_LEFT_UP, "Left Side Up" },
926 { DRM_MODE_PANEL_ORIENTATION_RIGHT_UP, "Right Side Up" },
929 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
930 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
931 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
932 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
934 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
936 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
937 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
938 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
939 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
941 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
942 drm_dvi_i_subconnector_enum_list)
944 static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
945 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
946 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
947 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
948 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
949 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
951 DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
953 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
954 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
955 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
956 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
957 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
958 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
960 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
961 drm_tv_subconnector_enum_list)
963 static const struct drm_prop_enum_list drm_dp_subconnector_enum_list[] = {
964 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
965 { DRM_MODE_SUBCONNECTOR_VGA, "VGA" }, /* DP */
966 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DP */
967 { DRM_MODE_SUBCONNECTOR_HDMIA, "HDMI" }, /* DP */
968 { DRM_MODE_SUBCONNECTOR_DisplayPort, "DP" }, /* DP */
969 { DRM_MODE_SUBCONNECTOR_Wireless, "Wireless" }, /* DP */
970 { DRM_MODE_SUBCONNECTOR_Native, "Native" }, /* DP */
973 DRM_ENUM_NAME_FN(drm_get_dp_subconnector_name,
974 drm_dp_subconnector_enum_list)
976 static const struct drm_prop_enum_list hdmi_colorspaces[] = {
977 /* For Default case, driver will set the colorspace */
978 { DRM_MODE_COLORIMETRY_DEFAULT, "Default" },
979 /* Standard Definition Colorimetry based on CEA 861 */
980 { DRM_MODE_COLORIMETRY_SMPTE_170M_YCC, "SMPTE_170M_YCC" },
981 { DRM_MODE_COLORIMETRY_BT709_YCC, "BT709_YCC" },
982 /* Standard Definition Colorimetry based on IEC 61966-2-4 */
983 { DRM_MODE_COLORIMETRY_XVYCC_601, "XVYCC_601" },
984 /* High Definition Colorimetry based on IEC 61966-2-4 */
985 { DRM_MODE_COLORIMETRY_XVYCC_709, "XVYCC_709" },
986 /* Colorimetry based on IEC 61966-2-1/Amendment 1 */
987 { DRM_MODE_COLORIMETRY_SYCC_601, "SYCC_601" },
988 /* Colorimetry based on IEC 61966-2-5 [33] */
989 { DRM_MODE_COLORIMETRY_OPYCC_601, "opYCC_601" },
990 /* Colorimetry based on IEC 61966-2-5 */
991 { DRM_MODE_COLORIMETRY_OPRGB, "opRGB" },
992 /* Colorimetry based on ITU-R BT.2020 */
993 { DRM_MODE_COLORIMETRY_BT2020_CYCC, "BT2020_CYCC" },
994 /* Colorimetry based on ITU-R BT.2020 */
995 { DRM_MODE_COLORIMETRY_BT2020_RGB, "BT2020_RGB" },
996 /* Colorimetry based on ITU-R BT.2020 */
997 { DRM_MODE_COLORIMETRY_BT2020_YCC, "BT2020_YCC" },
998 /* Added as part of Additional Colorimetry Extension in 861.G */
999 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65, "DCI-P3_RGB_D65" },
1000 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER, "DCI-P3_RGB_Theater" },
1004 * As per DP 1.4a spec, 2.2.5.7.5 VSC SDP Payload for Pixel Encoding/Colorimetry
1005 * Format Table 2-120
1007 static const struct drm_prop_enum_list dp_colorspaces[] = {
1008 /* For Default case, driver will set the colorspace */
1009 { DRM_MODE_COLORIMETRY_DEFAULT, "Default" },
1010 { DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED, "RGB_Wide_Gamut_Fixed_Point" },
1011 /* Colorimetry based on scRGB (IEC 61966-2-2) */
1012 { DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT, "RGB_Wide_Gamut_Floating_Point" },
1013 /* Colorimetry based on IEC 61966-2-5 */
1014 { DRM_MODE_COLORIMETRY_OPRGB, "opRGB" },
1015 /* Colorimetry based on SMPTE RP 431-2 */
1016 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65, "DCI-P3_RGB_D65" },
1017 /* Colorimetry based on ITU-R BT.2020 */
1018 { DRM_MODE_COLORIMETRY_BT2020_RGB, "BT2020_RGB" },
1019 { DRM_MODE_COLORIMETRY_BT601_YCC, "BT601_YCC" },
1020 { DRM_MODE_COLORIMETRY_BT709_YCC, "BT709_YCC" },
1021 /* Standard Definition Colorimetry based on IEC 61966-2-4 */
1022 { DRM_MODE_COLORIMETRY_XVYCC_601, "XVYCC_601" },
1023 /* High Definition Colorimetry based on IEC 61966-2-4 */
1024 { DRM_MODE_COLORIMETRY_XVYCC_709, "XVYCC_709" },
1025 /* Colorimetry based on IEC 61966-2-1/Amendment 1 */
1026 { DRM_MODE_COLORIMETRY_SYCC_601, "SYCC_601" },
1027 /* Colorimetry based on IEC 61966-2-5 [33] */
1028 { DRM_MODE_COLORIMETRY_OPYCC_601, "opYCC_601" },
1029 /* Colorimetry based on ITU-R BT.2020 */
1030 { DRM_MODE_COLORIMETRY_BT2020_CYCC, "BT2020_CYCC" },
1031 /* Colorimetry based on ITU-R BT.2020 */
1032 { DRM_MODE_COLORIMETRY_BT2020_YCC, "BT2020_YCC" },
1036 * DOC: standard connector properties
1038 * DRM connectors have a few standardized properties:
1041 * Blob property which contains the current EDID read from the sink. This
1042 * is useful to parse sink identification information like vendor, model
1043 * and serial. Drivers should update this property by calling
1044 * drm_connector_update_edid_property(), usually after having parsed
1045 * the EDID using drm_add_edid_modes(). Userspace cannot change this
1048 * User-space should not parse the EDID to obtain information exposed via
1049 * other KMS properties (because the kernel might apply limits, quirks or
1050 * fixups to the EDID). For instance, user-space should not try to parse
1051 * mode lists from the EDID.
1053 * Legacy property for setting the power state of the connector. For atomic
1054 * drivers this is only provided for backwards compatibility with existing
1055 * drivers, it remaps to controlling the "ACTIVE" property on the CRTC the
1056 * connector is linked to. Drivers should never set this property directly,
1057 * it is handled by the DRM core by calling the &drm_connector_funcs.dpms
1058 * callback. For atomic drivers the remapping to the "ACTIVE" property is
1059 * implemented in the DRM core.
1061 * Note that this property cannot be set through the MODE_ATOMIC ioctl,
1062 * userspace must use "ACTIVE" on the CRTC instead.
1066 * For userspace also running on legacy drivers the "DPMS" semantics are a
1067 * lot more complicated. First, userspace cannot rely on the "DPMS" value
1068 * returned by the GETCONNECTOR actually reflecting reality, because many
1069 * drivers fail to update it. For atomic drivers this is taken care of in
1070 * drm_atomic_helper_update_legacy_modeset_state().
1072 * The second issue is that the DPMS state is only well-defined when the
1073 * connector is connected to a CRTC. In atomic the DRM core enforces that
1074 * "ACTIVE" is off in such a case, no such checks exists for "DPMS".
1076 * Finally, when enabling an output using the legacy SETCONFIG ioctl then
1077 * "DPMS" is forced to ON. But see above, that might not be reflected in
1078 * the software value on legacy drivers.
1080 * Summarizing: Only set "DPMS" when the connector is known to be enabled,
1081 * assume that a successful SETCONFIG call also sets "DPMS" to on, and
1082 * never read back the value of "DPMS" because it can be incorrect.
1084 * Connector path property to identify how this sink is physically
1085 * connected. Used by DP MST. This should be set by calling
1086 * drm_connector_set_path_property(), in the case of DP MST with the
1087 * path property the MST manager created. Userspace cannot change this
1090 * Connector tile group property to indicate how a set of DRM connector
1091 * compose together into one logical screen. This is used by both high-res
1092 * external screens (often only using a single cable, but exposing multiple
1093 * DP MST sinks), or high-res integrated panels (like dual-link DSI) which
1094 * are not gen-locked. Note that for tiled panels which are genlocked, like
1095 * dual-link LVDS or dual-link DSI, the driver should try to not expose the
1096 * tiling and virtualise both &drm_crtc and &drm_plane if needed. Drivers
1097 * should update this value using drm_connector_set_tile_property().
1098 * Userspace cannot change this property.
1100 * Connector link-status property to indicate the status of link. The
1101 * default value of link-status is "GOOD". If something fails during or
1102 * after modeset, the kernel driver may set this to "BAD" and issue a
1103 * hotplug uevent. Drivers should update this value using
1104 * drm_connector_set_link_status_property().
1106 * When user-space receives the hotplug uevent and detects a "BAD"
1107 * link-status, the sink doesn't receive pixels anymore (e.g. the screen
1108 * becomes completely black). The list of available modes may have
1109 * changed. User-space is expected to pick a new mode if the current one
1110 * has disappeared and perform a new modeset with link-status set to
1111 * "GOOD" to re-enable the connector.
1113 * If multiple connectors share the same CRTC and one of them gets a "BAD"
1114 * link-status, the other are unaffected (ie. the sinks still continue to
1117 * When user-space performs an atomic commit on a connector with a "BAD"
1118 * link-status without resetting the property to "GOOD", the sink may
1119 * still not receive pixels. When user-space performs an atomic commit
1120 * which resets the link-status property to "GOOD" without the
1121 * ALLOW_MODESET flag set, it might fail because a modeset is required.
1123 * User-space can only change link-status to "GOOD", changing it to "BAD"
1126 * For backwards compatibility with non-atomic userspace the kernel
1127 * tries to automatically set the link-status back to "GOOD" in the
1128 * SETCRTC IOCTL. This might fail if the mode is no longer valid, similar
1129 * to how it might fail if a different screen has been connected in the
1132 * Indicates the output should be ignored for purposes of displaying a
1133 * standard desktop environment or console. This is most likely because
1134 * the output device is not rectilinear.
1135 * Content Protection:
1136 * This property is used by userspace to request the kernel protect future
1137 * content communicated over the link. When requested, kernel will apply
1138 * the appropriate means of protection (most often HDCP), and use the
1139 * property to tell userspace the protection is active.
1141 * Drivers can set this up by calling
1142 * drm_connector_attach_content_protection_property() on initialization.
1144 * The value of this property can be one of the following:
1146 * DRM_MODE_CONTENT_PROTECTION_UNDESIRED = 0
1147 * The link is not protected, content is transmitted in the clear.
1148 * DRM_MODE_CONTENT_PROTECTION_DESIRED = 1
1149 * Userspace has requested content protection, but the link is not
1150 * currently protected. When in this state, kernel should enable
1151 * Content Protection as soon as possible.
1152 * DRM_MODE_CONTENT_PROTECTION_ENABLED = 2
1153 * Userspace has requested content protection, and the link is
1154 * protected. Only the driver can set the property to this value.
1155 * If userspace attempts to set to ENABLED, kernel will return
1160 * - DESIRED state should be preserved until userspace de-asserts it by
1161 * setting the property to UNDESIRED. This means ENABLED should only
1162 * transition to UNDESIRED when the user explicitly requests it.
1163 * - If the state is DESIRED, kernel should attempt to re-authenticate the
1164 * link whenever possible. This includes across disable/enable, dpms,
1165 * hotplug, downstream device changes, link status failures, etc..
1166 * - Kernel sends uevent with the connector id and property id through
1167 * @drm_hdcp_update_content_protection, upon below kernel triggered
1170 * - DESIRED -> ENABLED (authentication success)
1171 * - ENABLED -> DESIRED (termination of authentication)
1172 * - Please note no uevents for userspace triggered property state changes,
1173 * which can't fail such as
1175 * - DESIRED/ENABLED -> UNDESIRED
1176 * - UNDESIRED -> DESIRED
1177 * - Userspace is responsible for polling the property or listen to uevents
1178 * to determine when the value transitions from ENABLED to DESIRED.
1179 * This signifies the link is no longer protected and userspace should
1180 * take appropriate action (whatever that might be).
1182 * HDCP Content Type:
1183 * This Enum property is used by the userspace to declare the content type
1184 * of the display stream, to kernel. Here display stream stands for any
1185 * display content that userspace intended to display through HDCP
1188 * Content Type of a stream is decided by the owner of the stream, as
1189 * "HDCP Type0" or "HDCP Type1".
1191 * The value of the property can be one of the below:
1192 * - "HDCP Type0": DRM_MODE_HDCP_CONTENT_TYPE0 = 0
1193 * - "HDCP Type1": DRM_MODE_HDCP_CONTENT_TYPE1 = 1
1195 * When kernel starts the HDCP authentication (see "Content Protection"
1196 * for details), it uses the content type in "HDCP Content Type"
1197 * for performing the HDCP authentication with the display sink.
1199 * Please note in HDCP spec versions, a link can be authenticated with
1200 * HDCP 2.2 for Content Type 0/Content Type 1. Where as a link can be
1201 * authenticated with HDCP1.4 only for Content Type 0(though it is implicit
1202 * in nature. As there is no reference for Content Type in HDCP1.4).
1204 * HDCP2.2 authentication protocol itself takes the "Content Type" as a
1205 * parameter, which is a input for the DP HDCP2.2 encryption algo.
1207 * In case of Type 0 content protection request, kernel driver can choose
1208 * either of HDCP spec versions 1.4 and 2.2. When HDCP2.2 is used for
1209 * "HDCP Type 0", a HDCP 2.2 capable repeater in the downstream can send
1210 * that content to a HDCP 1.4 authenticated HDCP sink (Type0 link).
1211 * But if the content is classified as "HDCP Type 1", above mentioned
1212 * HDCP 2.2 repeater wont send the content to the HDCP sink as it can't
1213 * authenticate the HDCP1.4 capable sink for "HDCP Type 1".
1215 * Please note userspace can be ignorant of the HDCP versions used by the
1216 * kernel driver to achieve the "HDCP Content Type".
1218 * At current scenario, classifying a content as Type 1 ensures that the
1219 * content will be displayed only through the HDCP2.2 encrypted link.
1221 * Note that the HDCP Content Type property is introduced at HDCP 2.2, and
1222 * defaults to type 0. It is only exposed by drivers supporting HDCP 2.2
1223 * (hence supporting Type 0 and Type 1). Based on how next versions of
1224 * HDCP specs are defined content Type could be used for higher versions
1227 * If content type is changed when "Content Protection" is not UNDESIRED,
1228 * then kernel will disable the HDCP and re-enable with new type in the
1229 * same atomic commit. And when "Content Protection" is ENABLED, it means
1230 * that link is HDCP authenticated and encrypted, for the transmission of
1231 * the Type of stream mentioned at "HDCP Content Type".
1233 * HDR_OUTPUT_METADATA:
1234 * Connector property to enable userspace to send HDR Metadata to
1235 * driver. This metadata is based on the composition and blending
1236 * policies decided by user, taking into account the hardware and
1237 * sink capabilities. The driver gets this metadata and creates a
1238 * Dynamic Range and Mastering Infoframe (DRM) in case of HDMI,
1239 * SDP packet (Non-audio INFOFRAME SDP v1.3) for DP. This is then
1240 * sent to sink. This notifies the sink of the upcoming frame's Color
1241 * Encoding and Luminance parameters.
1243 * Userspace first need to detect the HDR capabilities of sink by
1244 * reading and parsing the EDID. Details of HDR metadata for HDMI
1245 * are added in CTA 861.G spec. For DP , its defined in VESA DP
1246 * Standard v1.4. It needs to then get the metadata information
1247 * of the video/game/app content which are encoded in HDR (basically
1248 * using HDR transfer functions). With this information it needs to
1249 * decide on a blending policy and compose the relevant
1250 * layers/overlays into a common format. Once this blending is done,
1251 * userspace will be aware of the metadata of the composed frame to
1252 * be send to sink. It then uses this property to communicate this
1253 * metadata to driver which then make a Infoframe packet and sends
1254 * to sink based on the type of encoder connected.
1256 * Userspace will be responsible to do Tone mapping operation in case:
1257 * - Some layers are HDR and others are SDR
1258 * - HDR layers luminance is not same as sink
1260 * It will even need to do colorspace conversion and get all layers
1261 * to one common colorspace for blending. It can use either GL, Media
1262 * or display engine to get this done based on the capabilities of the
1263 * associated hardware.
1265 * Driver expects metadata to be put in &struct hdr_output_metadata
1266 * structure from userspace. This is received as blob and stored in
1267 * &drm_connector_state.hdr_output_metadata. It parses EDID and saves the
1268 * sink metadata in &struct hdr_sink_metadata, as
1269 * &drm_connector.hdr_sink_metadata. Driver uses
1270 * drm_hdmi_infoframe_set_hdr_metadata() helper to set the HDR metadata,
1271 * hdmi_drm_infoframe_pack() to pack the infoframe as per spec, in case of
1275 * This range property is used by userspace to limit the bit depth. When
1276 * used the driver would limit the bpc in accordance with the valid range
1277 * supported by the hardware and sink. Drivers to use the function
1278 * drm_connector_attach_max_bpc_property() to create and attach the
1279 * property to the connector during initialization.
1281 * Connectors also have one standardized atomic property:
1284 * Mode object ID of the &drm_crtc this connector should be connected to.
1286 * Connectors for LCD panels may also have one standardized property:
1288 * panel orientation:
1289 * On some devices the LCD panel is mounted in the casing in such a way
1290 * that the up/top side of the panel does not match with the top side of
1291 * the device. Userspace can use this property to check for this.
1292 * Note that input coordinates from touchscreens (input devices with
1293 * INPUT_PROP_DIRECT) will still map 1:1 to the actual LCD panel
1294 * coordinates, so if userspace rotates the picture to adjust for
1295 * the orientation it must also apply the same transformation to the
1296 * touchscreen input coordinates. This property is initialized by calling
1297 * drm_connector_set_panel_orientation() or
1298 * drm_connector_set_panel_orientation_with_quirk()
1301 * This property defines how a non-native mode is upscaled to the native
1302 * mode of an LCD panel:
1305 * No upscaling happens, scaling is left to the panel. Not all
1306 * drivers expose this mode.
1308 * The output is upscaled to the full resolution of the panel,
1309 * ignoring the aspect ratio.
1311 * No upscaling happens, the output is centered within the native
1312 * resolution the panel.
1314 * The output is upscaled to maximize either the width or height
1315 * while retaining the aspect ratio.
1317 * This property should be set up by calling
1318 * drm_connector_attach_scaling_mode_property(). Note that drivers
1319 * can also expose this property to external outputs, in which case they
1320 * must support "None", which should be the default (since external screens
1321 * have a built-in scaler).
1324 * This property is used by DVI-I, TVout and DisplayPort to indicate different
1325 * connector subtypes. Enum values more or less match with those from main
1327 * For DVI-I and TVout there is also a matching property "select subconnector"
1328 * allowing to switch between signal types.
1329 * DP subconnector corresponds to a downstream port.
1332 int drm_connector_create_standard_properties(struct drm_device *dev)
1334 struct drm_property *prop;
1336 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1337 DRM_MODE_PROP_IMMUTABLE,
1341 dev->mode_config.edid_property = prop;
1343 prop = drm_property_create_enum(dev, 0,
1344 "DPMS", drm_dpms_enum_list,
1345 ARRAY_SIZE(drm_dpms_enum_list));
1348 dev->mode_config.dpms_property = prop;
1350 prop = drm_property_create(dev,
1351 DRM_MODE_PROP_BLOB |
1352 DRM_MODE_PROP_IMMUTABLE,
1356 dev->mode_config.path_property = prop;
1358 prop = drm_property_create(dev,
1359 DRM_MODE_PROP_BLOB |
1360 DRM_MODE_PROP_IMMUTABLE,
1364 dev->mode_config.tile_property = prop;
1366 prop = drm_property_create_enum(dev, 0, "link-status",
1367 drm_link_status_enum_list,
1368 ARRAY_SIZE(drm_link_status_enum_list));
1371 dev->mode_config.link_status_property = prop;
1373 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE, "non-desktop");
1376 dev->mode_config.non_desktop_property = prop;
1378 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB,
1379 "HDR_OUTPUT_METADATA", 0);
1382 dev->mode_config.hdr_output_metadata_property = prop;
1388 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1391 * Called by a driver the first time a DVI-I connector is made.
1393 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1395 struct drm_property *dvi_i_selector;
1396 struct drm_property *dvi_i_subconnector;
1398 if (dev->mode_config.dvi_i_select_subconnector_property)
1402 drm_property_create_enum(dev, 0,
1403 "select subconnector",
1404 drm_dvi_i_select_enum_list,
1405 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1406 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1408 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1410 drm_dvi_i_subconnector_enum_list,
1411 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1412 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1416 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1419 * drm_connector_attach_dp_subconnector_property - create subconnector property for DP
1420 * @connector: drm_connector to attach property
1422 * Called by a driver when DP connector is created.
1424 void drm_connector_attach_dp_subconnector_property(struct drm_connector *connector)
1426 struct drm_mode_config *mode_config = &connector->dev->mode_config;
1428 if (!mode_config->dp_subconnector_property)
1429 mode_config->dp_subconnector_property =
1430 drm_property_create_enum(connector->dev,
1431 DRM_MODE_PROP_IMMUTABLE,
1433 drm_dp_subconnector_enum_list,
1434 ARRAY_SIZE(drm_dp_subconnector_enum_list));
1436 drm_object_attach_property(&connector->base,
1437 mode_config->dp_subconnector_property,
1438 DRM_MODE_SUBCONNECTOR_Unknown);
1440 EXPORT_SYMBOL(drm_connector_attach_dp_subconnector_property);
1443 * DOC: HDMI connector properties
1445 * content type (HDMI specific):
1446 * Indicates content type setting to be used in HDMI infoframes to indicate
1447 * content type for the external device, so that it adjusts its display
1448 * settings accordingly.
1450 * The value of this property can be one of the following:
1453 * Content type is unknown
1455 * Content type is graphics
1457 * Content type is photo
1459 * Content type is cinema
1461 * Content type is game
1463 * Drivers can set up this property by calling
1464 * drm_connector_attach_content_type_property(). Decoding to
1465 * infoframe values is done through drm_hdmi_avi_infoframe_content_type().
1469 * drm_connector_attach_content_type_property - attach content-type property
1470 * @connector: connector to attach content type property on.
1472 * Called by a driver the first time a HDMI connector is made.
1474 int drm_connector_attach_content_type_property(struct drm_connector *connector)
1476 if (!drm_mode_create_content_type_property(connector->dev))
1477 drm_object_attach_property(&connector->base,
1478 connector->dev->mode_config.content_type_property,
1479 DRM_MODE_CONTENT_TYPE_NO_DATA);
1482 EXPORT_SYMBOL(drm_connector_attach_content_type_property);
1486 * drm_hdmi_avi_infoframe_content_type() - fill the HDMI AVI infoframe
1487 * content type information, based
1488 * on correspondent DRM property.
1489 * @frame: HDMI AVI infoframe
1490 * @conn_state: DRM display connector state
1493 void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
1494 const struct drm_connector_state *conn_state)
1496 switch (conn_state->content_type) {
1497 case DRM_MODE_CONTENT_TYPE_GRAPHICS:
1498 frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1500 case DRM_MODE_CONTENT_TYPE_CINEMA:
1501 frame->content_type = HDMI_CONTENT_TYPE_CINEMA;
1503 case DRM_MODE_CONTENT_TYPE_GAME:
1504 frame->content_type = HDMI_CONTENT_TYPE_GAME;
1506 case DRM_MODE_CONTENT_TYPE_PHOTO:
1507 frame->content_type = HDMI_CONTENT_TYPE_PHOTO;
1510 /* Graphics is the default(0) */
1511 frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1514 frame->itc = conn_state->content_type != DRM_MODE_CONTENT_TYPE_NO_DATA;
1516 EXPORT_SYMBOL(drm_hdmi_avi_infoframe_content_type);
1519 * drm_connector_attach_tv_margin_properties - attach TV connector margin
1521 * @connector: DRM connector
1523 * Called by a driver when it needs to attach TV margin props to a connector.
1524 * Typically used on SDTV and HDMI connectors.
1526 void drm_connector_attach_tv_margin_properties(struct drm_connector *connector)
1528 struct drm_device *dev = connector->dev;
1530 drm_object_attach_property(&connector->base,
1531 dev->mode_config.tv_left_margin_property,
1533 drm_object_attach_property(&connector->base,
1534 dev->mode_config.tv_right_margin_property,
1536 drm_object_attach_property(&connector->base,
1537 dev->mode_config.tv_top_margin_property,
1539 drm_object_attach_property(&connector->base,
1540 dev->mode_config.tv_bottom_margin_property,
1543 EXPORT_SYMBOL(drm_connector_attach_tv_margin_properties);
1546 * drm_mode_create_tv_margin_properties - create TV connector margin properties
1549 * Called by a driver's HDMI connector initialization routine, this function
1550 * creates the TV margin properties for a given device. No need to call this
1551 * function for an SDTV connector, it's already called from
1552 * drm_mode_create_tv_properties().
1554 int drm_mode_create_tv_margin_properties(struct drm_device *dev)
1556 if (dev->mode_config.tv_left_margin_property)
1559 dev->mode_config.tv_left_margin_property =
1560 drm_property_create_range(dev, 0, "left margin", 0, 100);
1561 if (!dev->mode_config.tv_left_margin_property)
1564 dev->mode_config.tv_right_margin_property =
1565 drm_property_create_range(dev, 0, "right margin", 0, 100);
1566 if (!dev->mode_config.tv_right_margin_property)
1569 dev->mode_config.tv_top_margin_property =
1570 drm_property_create_range(dev, 0, "top margin", 0, 100);
1571 if (!dev->mode_config.tv_top_margin_property)
1574 dev->mode_config.tv_bottom_margin_property =
1575 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1576 if (!dev->mode_config.tv_bottom_margin_property)
1581 EXPORT_SYMBOL(drm_mode_create_tv_margin_properties);
1584 * drm_mode_create_tv_properties - create TV specific connector properties
1586 * @num_modes: number of different TV formats (modes) supported
1587 * @modes: array of pointers to strings containing name of each format
1589 * Called by a driver's TV initialization routine, this function creates
1590 * the TV specific connector properties for a given device. Caller is
1591 * responsible for allocating a list of format names and passing them to
1594 int drm_mode_create_tv_properties(struct drm_device *dev,
1595 unsigned int num_modes,
1596 const char * const modes[])
1598 struct drm_property *tv_selector;
1599 struct drm_property *tv_subconnector;
1602 if (dev->mode_config.tv_select_subconnector_property)
1606 * Basic connector properties
1608 tv_selector = drm_property_create_enum(dev, 0,
1609 "select subconnector",
1610 drm_tv_select_enum_list,
1611 ARRAY_SIZE(drm_tv_select_enum_list));
1615 dev->mode_config.tv_select_subconnector_property = tv_selector;
1618 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1620 drm_tv_subconnector_enum_list,
1621 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1622 if (!tv_subconnector)
1624 dev->mode_config.tv_subconnector_property = tv_subconnector;
1627 * Other, TV specific properties: margins & TV modes.
1629 if (drm_mode_create_tv_margin_properties(dev))
1632 dev->mode_config.tv_mode_property =
1633 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1635 if (!dev->mode_config.tv_mode_property)
1638 for (i = 0; i < num_modes; i++)
1639 drm_property_add_enum(dev->mode_config.tv_mode_property,
1642 dev->mode_config.tv_brightness_property =
1643 drm_property_create_range(dev, 0, "brightness", 0, 100);
1644 if (!dev->mode_config.tv_brightness_property)
1647 dev->mode_config.tv_contrast_property =
1648 drm_property_create_range(dev, 0, "contrast", 0, 100);
1649 if (!dev->mode_config.tv_contrast_property)
1652 dev->mode_config.tv_flicker_reduction_property =
1653 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1654 if (!dev->mode_config.tv_flicker_reduction_property)
1657 dev->mode_config.tv_overscan_property =
1658 drm_property_create_range(dev, 0, "overscan", 0, 100);
1659 if (!dev->mode_config.tv_overscan_property)
1662 dev->mode_config.tv_saturation_property =
1663 drm_property_create_range(dev, 0, "saturation", 0, 100);
1664 if (!dev->mode_config.tv_saturation_property)
1667 dev->mode_config.tv_hue_property =
1668 drm_property_create_range(dev, 0, "hue", 0, 100);
1669 if (!dev->mode_config.tv_hue_property)
1676 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1679 * drm_mode_create_scaling_mode_property - create scaling mode property
1682 * Called by a driver the first time it's needed, must be attached to desired
1685 * Atomic drivers should use drm_connector_attach_scaling_mode_property()
1686 * instead to correctly assign &drm_connector_state.picture_aspect_ratio
1687 * in the atomic state.
1689 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1691 struct drm_property *scaling_mode;
1693 if (dev->mode_config.scaling_mode_property)
1697 drm_property_create_enum(dev, 0, "scaling mode",
1698 drm_scaling_mode_enum_list,
1699 ARRAY_SIZE(drm_scaling_mode_enum_list));
1701 dev->mode_config.scaling_mode_property = scaling_mode;
1705 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1708 * DOC: Variable refresh properties
1710 * Variable refresh rate capable displays can dynamically adjust their
1711 * refresh rate by extending the duration of their vertical front porch
1712 * until page flip or timeout occurs. This can reduce or remove stuttering
1713 * and latency in scenarios where the page flip does not align with the
1716 * An example scenario would be an application flipping at a constant rate
1717 * of 48Hz on a 60Hz display. The page flip will frequently miss the vblank
1718 * interval and the same contents will be displayed twice. This can be
1719 * observed as stuttering for content with motion.
1721 * If variable refresh rate was active on a display that supported a
1722 * variable refresh range from 35Hz to 60Hz no stuttering would be observable
1723 * for the example scenario. The minimum supported variable refresh rate of
1724 * 35Hz is below the page flip frequency and the vertical front porch can
1725 * be extended until the page flip occurs. The vblank interval will be
1726 * directly aligned to the page flip rate.
1728 * Not all userspace content is suitable for use with variable refresh rate.
1729 * Large and frequent changes in vertical front porch duration may worsen
1730 * perceived stuttering for input sensitive applications.
1732 * Panel brightness will also vary with vertical front porch duration. Some
1733 * panels may have noticeable differences in brightness between the minimum
1734 * vertical front porch duration and the maximum vertical front porch duration.
1735 * Large and frequent changes in vertical front porch duration may produce
1736 * observable flickering for such panels.
1738 * Userspace control for variable refresh rate is supported via properties
1739 * on the &drm_connector and &drm_crtc objects.
1742 * Optional &drm_connector boolean property that drivers should attach
1743 * with drm_connector_attach_vrr_capable_property() on connectors that
1744 * could support variable refresh rates. Drivers should update the
1745 * property value by calling drm_connector_set_vrr_capable_property().
1747 * Absence of the property should indicate absence of support.
1750 * Default &drm_crtc boolean property that notifies the driver that the
1751 * content on the CRTC is suitable for variable refresh rate presentation.
1752 * The driver will take this property as a hint to enable variable
1753 * refresh rate support if the receiver supports it, ie. if the
1754 * "vrr_capable" property is true on the &drm_connector object. The
1755 * vertical front porch duration will be extended until page-flip or
1756 * timeout when enabled.
1758 * The minimum vertical front porch duration is defined as the vertical
1759 * front porch duration for the current mode.
1761 * The maximum vertical front porch duration is greater than or equal to
1762 * the minimum vertical front porch duration. The duration is derived
1763 * from the minimum supported variable refresh rate for the connector.
1765 * The driver may place further restrictions within these minimum
1766 * and maximum bounds.
1770 * drm_connector_attach_vrr_capable_property - creates the
1771 * vrr_capable property
1772 * @connector: connector to create the vrr_capable property on.
1774 * This is used by atomic drivers to add support for querying
1775 * variable refresh rate capability for a connector.
1778 * Zero on success, negative errno on failure.
1780 int drm_connector_attach_vrr_capable_property(
1781 struct drm_connector *connector)
1783 struct drm_device *dev = connector->dev;
1784 struct drm_property *prop;
1786 if (!connector->vrr_capable_property) {
1787 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE,
1792 connector->vrr_capable_property = prop;
1793 drm_object_attach_property(&connector->base, prop, 0);
1798 EXPORT_SYMBOL(drm_connector_attach_vrr_capable_property);
1801 * drm_connector_attach_scaling_mode_property - attach atomic scaling mode property
1802 * @connector: connector to attach scaling mode property on.
1803 * @scaling_mode_mask: or'ed mask of BIT(%DRM_MODE_SCALE_\*).
1805 * This is used to add support for scaling mode to atomic drivers.
1806 * The scaling mode will be set to &drm_connector_state.picture_aspect_ratio
1807 * and can be used from &drm_connector_helper_funcs->atomic_check for validation.
1809 * This is the atomic version of drm_mode_create_scaling_mode_property().
1812 * Zero on success, negative errno on failure.
1814 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1815 u32 scaling_mode_mask)
1817 struct drm_device *dev = connector->dev;
1818 struct drm_property *scaling_mode_property;
1820 const unsigned valid_scaling_mode_mask =
1821 (1U << ARRAY_SIZE(drm_scaling_mode_enum_list)) - 1;
1823 if (WARN_ON(hweight32(scaling_mode_mask) < 2 ||
1824 scaling_mode_mask & ~valid_scaling_mode_mask))
1827 scaling_mode_property =
1828 drm_property_create(dev, DRM_MODE_PROP_ENUM, "scaling mode",
1829 hweight32(scaling_mode_mask));
1831 if (!scaling_mode_property)
1834 for (i = 0; i < ARRAY_SIZE(drm_scaling_mode_enum_list); i++) {
1837 if (!(BIT(i) & scaling_mode_mask))
1840 ret = drm_property_add_enum(scaling_mode_property,
1841 drm_scaling_mode_enum_list[i].type,
1842 drm_scaling_mode_enum_list[i].name);
1845 drm_property_destroy(dev, scaling_mode_property);
1851 drm_object_attach_property(&connector->base,
1852 scaling_mode_property, 0);
1854 connector->scaling_mode_property = scaling_mode_property;
1858 EXPORT_SYMBOL(drm_connector_attach_scaling_mode_property);
1861 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1864 * Called by a driver the first time it's needed, must be attached to desired
1868 * Zero on success, negative errno on failure.
1870 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1872 if (dev->mode_config.aspect_ratio_property)
1875 dev->mode_config.aspect_ratio_property =
1876 drm_property_create_enum(dev, 0, "aspect ratio",
1877 drm_aspect_ratio_enum_list,
1878 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1880 if (dev->mode_config.aspect_ratio_property == NULL)
1885 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1888 * DOC: standard connector properties
1891 * This property helps select a suitable colorspace based on the sink
1892 * capability. Modern sink devices support wider gamut like BT2020.
1893 * This helps switch to BT2020 mode if the BT2020 encoded video stream
1894 * is being played by the user, same for any other colorspace. Thereby
1895 * giving a good visual experience to users.
1897 * The expectation from userspace is that it should parse the EDID
1898 * and get supported colorspaces. Use this property and switch to the
1899 * one supported. Sink supported colorspaces should be retrieved by
1900 * userspace from EDID and driver will not explicitly expose them.
1902 * Basically the expectation from userspace is:
1903 * - Set up CRTC DEGAMMA/CTM/GAMMA to convert to some sink
1905 * - Set this new property to let the sink know what it
1906 * converted the CRTC output to.
1907 * - This property is just to inform sink what colorspace
1908 * source is trying to drive.
1910 * Because between HDMI and DP have different colorspaces,
1911 * drm_mode_create_hdmi_colorspace_property() is used for HDMI connector and
1912 * drm_mode_create_dp_colorspace_property() is used for DP connector.
1916 * drm_mode_create_hdmi_colorspace_property - create hdmi colorspace property
1917 * @connector: connector to create the Colorspace property on.
1919 * Called by a driver the first time it's needed, must be attached to desired
1923 * Zero on success, negative errno on failure.
1925 int drm_mode_create_hdmi_colorspace_property(struct drm_connector *connector)
1927 struct drm_device *dev = connector->dev;
1929 if (connector->colorspace_property)
1932 connector->colorspace_property =
1933 drm_property_create_enum(dev, DRM_MODE_PROP_ENUM, "Colorspace",
1935 ARRAY_SIZE(hdmi_colorspaces));
1937 if (!connector->colorspace_property)
1942 EXPORT_SYMBOL(drm_mode_create_hdmi_colorspace_property);
1945 * drm_mode_create_dp_colorspace_property - create dp colorspace property
1946 * @connector: connector to create the Colorspace property on.
1948 * Called by a driver the first time it's needed, must be attached to desired
1952 * Zero on success, negative errno on failure.
1954 int drm_mode_create_dp_colorspace_property(struct drm_connector *connector)
1956 struct drm_device *dev = connector->dev;
1958 if (connector->colorspace_property)
1961 connector->colorspace_property =
1962 drm_property_create_enum(dev, DRM_MODE_PROP_ENUM, "Colorspace",
1964 ARRAY_SIZE(dp_colorspaces));
1966 if (!connector->colorspace_property)
1971 EXPORT_SYMBOL(drm_mode_create_dp_colorspace_property);
1974 * drm_mode_create_content_type_property - create content type property
1977 * Called by a driver the first time it's needed, must be attached to desired
1981 * Zero on success, negative errno on failure.
1983 int drm_mode_create_content_type_property(struct drm_device *dev)
1985 if (dev->mode_config.content_type_property)
1988 dev->mode_config.content_type_property =
1989 drm_property_create_enum(dev, 0, "content type",
1990 drm_content_type_enum_list,
1991 ARRAY_SIZE(drm_content_type_enum_list));
1993 if (dev->mode_config.content_type_property == NULL)
1998 EXPORT_SYMBOL(drm_mode_create_content_type_property);
2001 * drm_mode_create_suggested_offset_properties - create suggests offset properties
2004 * Create the suggested x/y offset property for connectors.
2006 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
2008 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
2011 dev->mode_config.suggested_x_property =
2012 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
2014 dev->mode_config.suggested_y_property =
2015 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
2017 if (dev->mode_config.suggested_x_property == NULL ||
2018 dev->mode_config.suggested_y_property == NULL)
2022 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
2025 * drm_connector_set_path_property - set tile property on connector
2026 * @connector: connector to set property on.
2027 * @path: path to use for property; must not be NULL.
2029 * This creates a property to expose to userspace to specify a
2030 * connector path. This is mainly used for DisplayPort MST where
2031 * connectors have a topology and we want to allow userspace to give
2032 * them more meaningful names.
2035 * Zero on success, negative errno on failure.
2037 int drm_connector_set_path_property(struct drm_connector *connector,
2040 struct drm_device *dev = connector->dev;
2043 ret = drm_property_replace_global_blob(dev,
2044 &connector->path_blob_ptr,
2048 dev->mode_config.path_property);
2051 EXPORT_SYMBOL(drm_connector_set_path_property);
2054 * drm_connector_set_tile_property - set tile property on connector
2055 * @connector: connector to set property on.
2057 * This looks up the tile information for a connector, and creates a
2058 * property for userspace to parse if it exists. The property is of
2059 * the form of 8 integers using ':' as a separator.
2060 * This is used for dual port tiled displays with DisplayPort SST
2061 * or DisplayPort MST connectors.
2064 * Zero on success, errno on failure.
2066 int drm_connector_set_tile_property(struct drm_connector *connector)
2068 struct drm_device *dev = connector->dev;
2072 if (!connector->has_tile) {
2073 ret = drm_property_replace_global_blob(dev,
2074 &connector->tile_blob_ptr,
2078 dev->mode_config.tile_property);
2082 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
2083 connector->tile_group->id, connector->tile_is_single_monitor,
2084 connector->num_h_tile, connector->num_v_tile,
2085 connector->tile_h_loc, connector->tile_v_loc,
2086 connector->tile_h_size, connector->tile_v_size);
2088 ret = drm_property_replace_global_blob(dev,
2089 &connector->tile_blob_ptr,
2093 dev->mode_config.tile_property);
2096 EXPORT_SYMBOL(drm_connector_set_tile_property);
2099 * drm_connector_update_edid_property - update the edid property of a connector
2100 * @connector: drm connector
2101 * @edid: new value of the edid property
2103 * This function creates a new blob modeset object and assigns its id to the
2104 * connector's edid property.
2105 * Since we also parse tile information from EDID's displayID block, we also
2106 * set the connector's tile property here. See drm_connector_set_tile_property()
2110 * Zero on success, negative errno on failure.
2112 int drm_connector_update_edid_property(struct drm_connector *connector,
2113 const struct edid *edid)
2115 struct drm_device *dev = connector->dev;
2118 const struct edid *old_edid;
2120 /* ignore requests to set edid when overridden */
2121 if (connector->override_edid)
2125 size = EDID_LENGTH * (1 + edid->extensions);
2127 /* Set the display info, using edid if available, otherwise
2128 * resetting the values to defaults. This duplicates the work
2129 * done in drm_add_edid_modes, but that function is not
2130 * consistently called before this one in all drivers and the
2131 * computation is cheap enough that it seems better to
2132 * duplicate it rather than attempt to ensure some arbitrary
2133 * ordering of calls.
2136 drm_add_display_info(connector, edid);
2138 drm_reset_display_info(connector);
2140 drm_update_tile_info(connector, edid);
2142 if (connector->edid_blob_ptr) {
2143 old_edid = (const struct edid *)connector->edid_blob_ptr->data;
2145 if (!drm_edid_are_equal(edid, old_edid)) {
2146 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] Edid was changed.\n",
2147 connector->base.id, connector->name);
2149 connector->epoch_counter += 1;
2150 DRM_DEBUG_KMS("Updating change counter to %llu\n",
2151 connector->epoch_counter);
2156 drm_object_property_set_value(&connector->base,
2157 dev->mode_config.non_desktop_property,
2158 connector->display_info.non_desktop);
2160 ret = drm_property_replace_global_blob(dev,
2161 &connector->edid_blob_ptr,
2165 dev->mode_config.edid_property);
2168 return drm_connector_set_tile_property(connector);
2170 EXPORT_SYMBOL(drm_connector_update_edid_property);
2173 * drm_connector_set_link_status_property - Set link status property of a connector
2174 * @connector: drm connector
2175 * @link_status: new value of link status property (0: Good, 1: Bad)
2177 * In usual working scenario, this link status property will always be set to
2178 * "GOOD". If something fails during or after a mode set, the kernel driver
2179 * may set this link status property to "BAD". The caller then needs to send a
2180 * hotplug uevent for userspace to re-check the valid modes through
2181 * GET_CONNECTOR_IOCTL and retry modeset.
2183 * Note: Drivers cannot rely on userspace to support this property and
2184 * issue a modeset. As such, they may choose to handle issues (like
2185 * re-training a link) without userspace's intervention.
2187 * The reason for adding this property is to handle link training failures, but
2188 * it is not limited to DP or link training. For example, if we implement
2189 * asynchronous setcrtc, this property can be used to report any failures in that.
2191 void drm_connector_set_link_status_property(struct drm_connector *connector,
2192 uint64_t link_status)
2194 struct drm_device *dev = connector->dev;
2196 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2197 connector->state->link_status = link_status;
2198 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2200 EXPORT_SYMBOL(drm_connector_set_link_status_property);
2203 * drm_connector_attach_max_bpc_property - attach "max bpc" property
2204 * @connector: connector to attach max bpc property on.
2205 * @min: The minimum bit depth supported by the connector.
2206 * @max: The maximum bit depth supported by the connector.
2208 * This is used to add support for limiting the bit depth on a connector.
2211 * Zero on success, negative errno on failure.
2213 int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
2216 struct drm_device *dev = connector->dev;
2217 struct drm_property *prop;
2219 prop = connector->max_bpc_property;
2221 prop = drm_property_create_range(dev, 0, "max bpc", min, max);
2225 connector->max_bpc_property = prop;
2228 drm_object_attach_property(&connector->base, prop, max);
2229 connector->state->max_requested_bpc = max;
2230 connector->state->max_bpc = max;
2234 EXPORT_SYMBOL(drm_connector_attach_max_bpc_property);
2237 * drm_connector_attach_hdr_output_metadata_property - attach "HDR_OUTPUT_METADA" property
2238 * @connector: connector to attach the property on.
2240 * This is used to allow the userspace to send HDR Metadata to the
2244 * Zero on success, negative errno on failure.
2246 int drm_connector_attach_hdr_output_metadata_property(struct drm_connector *connector)
2248 struct drm_device *dev = connector->dev;
2249 struct drm_property *prop = dev->mode_config.hdr_output_metadata_property;
2251 drm_object_attach_property(&connector->base, prop, 0);
2255 EXPORT_SYMBOL(drm_connector_attach_hdr_output_metadata_property);
2258 * drm_connector_attach_colorspace_property - attach "Colorspace" property
2259 * @connector: connector to attach the property on.
2261 * This is used to allow the userspace to signal the output colorspace
2265 * Zero on success, negative errno on failure.
2267 int drm_connector_attach_colorspace_property(struct drm_connector *connector)
2269 struct drm_property *prop = connector->colorspace_property;
2271 drm_object_attach_property(&connector->base, prop, DRM_MODE_COLORIMETRY_DEFAULT);
2275 EXPORT_SYMBOL(drm_connector_attach_colorspace_property);
2278 * drm_connector_atomic_hdr_metadata_equal - checks if the hdr metadata changed
2279 * @old_state: old connector state to compare
2280 * @new_state: new connector state to compare
2282 * This is used by HDR-enabled drivers to test whether the HDR metadata
2283 * have changed between two different connector state (and thus probably
2284 * requires a full blown mode change).
2287 * True if the metadata are equal, False otherwise
2289 bool drm_connector_atomic_hdr_metadata_equal(struct drm_connector_state *old_state,
2290 struct drm_connector_state *new_state)
2292 struct drm_property_blob *old_blob = old_state->hdr_output_metadata;
2293 struct drm_property_blob *new_blob = new_state->hdr_output_metadata;
2295 if (!old_blob || !new_blob)
2296 return old_blob == new_blob;
2298 if (old_blob->length != new_blob->length)
2301 return !memcmp(old_blob->data, new_blob->data, old_blob->length);
2303 EXPORT_SYMBOL(drm_connector_atomic_hdr_metadata_equal);
2306 * drm_connector_set_vrr_capable_property - sets the variable refresh rate
2307 * capable property for a connector
2308 * @connector: drm connector
2309 * @capable: True if the connector is variable refresh rate capable
2311 * Should be used by atomic drivers to update the indicated support for
2312 * variable refresh rate over a connector.
2314 void drm_connector_set_vrr_capable_property(
2315 struct drm_connector *connector, bool capable)
2317 if (!connector->vrr_capable_property)
2320 drm_object_property_set_value(&connector->base,
2321 connector->vrr_capable_property,
2324 EXPORT_SYMBOL(drm_connector_set_vrr_capable_property);
2327 * drm_connector_set_panel_orientation - sets the connector's panel_orientation
2328 * @connector: connector for which to set the panel-orientation property.
2329 * @panel_orientation: drm_panel_orientation value to set
2331 * This function sets the connector's panel_orientation and attaches
2332 * a "panel orientation" property to the connector.
2334 * Calling this function on a connector where the panel_orientation has
2335 * already been set is a no-op (e.g. the orientation has been overridden with
2336 * a kernel commandline option).
2338 * It is allowed to call this function with a panel_orientation of
2339 * DRM_MODE_PANEL_ORIENTATION_UNKNOWN, in which case it is a no-op.
2342 * Zero on success, negative errno on failure.
2344 int drm_connector_set_panel_orientation(
2345 struct drm_connector *connector,
2346 enum drm_panel_orientation panel_orientation)
2348 struct drm_device *dev = connector->dev;
2349 struct drm_display_info *info = &connector->display_info;
2350 struct drm_property *prop;
2353 if (info->panel_orientation != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2356 /* Don't attach the property if the orientation is unknown */
2357 if (panel_orientation == DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2360 info->panel_orientation = panel_orientation;
2362 prop = dev->mode_config.panel_orientation_property;
2364 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
2365 "panel orientation",
2366 drm_panel_orientation_enum_list,
2367 ARRAY_SIZE(drm_panel_orientation_enum_list));
2371 dev->mode_config.panel_orientation_property = prop;
2374 drm_object_attach_property(&connector->base, prop,
2375 info->panel_orientation);
2378 EXPORT_SYMBOL(drm_connector_set_panel_orientation);
2381 * drm_connector_set_panel_orientation_with_quirk -
2382 * set the connector's panel_orientation after checking for quirks
2383 * @connector: connector for which to init the panel-orientation property.
2384 * @panel_orientation: drm_panel_orientation value to set
2385 * @width: width in pixels of the panel, used for panel quirk detection
2386 * @height: height in pixels of the panel, used for panel quirk detection
2388 * Like drm_connector_set_panel_orientation(), but with a check for platform
2389 * specific (e.g. DMI based) quirks overriding the passed in panel_orientation.
2392 * Zero on success, negative errno on failure.
2394 int drm_connector_set_panel_orientation_with_quirk(
2395 struct drm_connector *connector,
2396 enum drm_panel_orientation panel_orientation,
2397 int width, int height)
2399 int orientation_quirk;
2401 orientation_quirk = drm_get_panel_orientation_quirk(width, height);
2402 if (orientation_quirk != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2403 panel_orientation = orientation_quirk;
2405 return drm_connector_set_panel_orientation(connector,
2408 EXPORT_SYMBOL(drm_connector_set_panel_orientation_with_quirk);
2410 int drm_connector_set_obj_prop(struct drm_mode_object *obj,
2411 struct drm_property *property,
2415 struct drm_connector *connector = obj_to_connector(obj);
2417 /* Do DPMS ourselves */
2418 if (property == connector->dev->mode_config.dpms_property) {
2419 ret = (*connector->funcs->dpms)(connector, (int)value);
2420 } else if (connector->funcs->set_property)
2421 ret = connector->funcs->set_property(connector, property, value);
2424 drm_object_property_set_value(&connector->base, property, value);
2428 int drm_connector_property_set_ioctl(struct drm_device *dev,
2429 void *data, struct drm_file *file_priv)
2431 struct drm_mode_connector_set_property *conn_set_prop = data;
2432 struct drm_mode_obj_set_property obj_set_prop = {
2433 .value = conn_set_prop->value,
2434 .prop_id = conn_set_prop->prop_id,
2435 .obj_id = conn_set_prop->connector_id,
2436 .obj_type = DRM_MODE_OBJECT_CONNECTOR
2439 /* It does all the locking and checking we need */
2440 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
2443 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
2445 /* For atomic drivers only state objects are synchronously updated and
2446 * protected by modeset locks, so check those first.
2448 if (connector->state)
2449 return connector->state->best_encoder;
2450 return connector->encoder;
2454 drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
2455 const struct list_head *modes,
2456 const struct drm_file *file_priv)
2459 * If user-space hasn't configured the driver to expose the stereo 3D
2460 * modes, don't expose them.
2462 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
2465 * If user-space hasn't configured the driver to expose the modes
2466 * with aspect-ratio, don't expose them. However if such a mode
2467 * is unique, let it be exposed, but reset the aspect-ratio flags
2468 * while preparing the list of user-modes.
2470 if (!file_priv->aspect_ratio_allowed) {
2471 const struct drm_display_mode *mode_itr;
2473 list_for_each_entry(mode_itr, modes, head) {
2474 if (mode_itr->expose_to_userspace &&
2475 drm_mode_match(mode_itr, mode,
2476 DRM_MODE_MATCH_TIMINGS |
2477 DRM_MODE_MATCH_CLOCK |
2478 DRM_MODE_MATCH_FLAGS |
2479 DRM_MODE_MATCH_3D_FLAGS))
2487 int drm_mode_getconnector(struct drm_device *dev, void *data,
2488 struct drm_file *file_priv)
2490 struct drm_mode_get_connector *out_resp = data;
2491 struct drm_connector *connector;
2492 struct drm_encoder *encoder;
2493 struct drm_display_mode *mode;
2495 int encoders_count = 0;
2498 struct drm_mode_modeinfo u_mode;
2499 struct drm_mode_modeinfo __user *mode_ptr;
2500 uint32_t __user *encoder_ptr;
2501 bool is_current_master;
2503 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2506 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2508 connector = drm_connector_lookup(dev, file_priv, out_resp->connector_id);
2512 encoders_count = hweight32(connector->possible_encoders);
2514 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2516 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2518 drm_connector_for_each_possible_encoder(connector, encoder) {
2519 if (put_user(encoder->base.id, encoder_ptr + copied)) {
2526 out_resp->count_encoders = encoders_count;
2528 out_resp->connector_id = connector->base.id;
2529 out_resp->connector_type = connector->connector_type;
2530 out_resp->connector_type_id = connector->connector_type_id;
2532 is_current_master = drm_is_current_master(file_priv);
2534 mutex_lock(&dev->mode_config.mutex);
2535 if (out_resp->count_modes == 0) {
2536 if (is_current_master)
2537 connector->funcs->fill_modes(connector,
2538 dev->mode_config.max_width,
2539 dev->mode_config.max_height);
2541 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",
2542 connector->base.id, connector->name);
2545 out_resp->mm_width = connector->display_info.width_mm;
2546 out_resp->mm_height = connector->display_info.height_mm;
2547 out_resp->subpixel = connector->display_info.subpixel_order;
2548 out_resp->connection = connector->status;
2550 /* delayed so we get modes regardless of pre-fill_modes state */
2551 list_for_each_entry(mode, &connector->modes, head) {
2552 WARN_ON(mode->expose_to_userspace);
2554 if (drm_mode_expose_to_userspace(mode, &connector->modes,
2556 mode->expose_to_userspace = true;
2562 * This ioctl is called twice, once to determine how much space is
2563 * needed, and the 2nd time to fill it.
2565 if ((out_resp->count_modes >= mode_count) && mode_count) {
2567 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2568 list_for_each_entry(mode, &connector->modes, head) {
2569 if (!mode->expose_to_userspace)
2572 /* Clear the tag for the next time around */
2573 mode->expose_to_userspace = false;
2575 drm_mode_convert_to_umode(&u_mode, mode);
2577 * Reset aspect ratio flags of user-mode, if modes with
2578 * aspect-ratio are not supported.
2580 if (!file_priv->aspect_ratio_allowed)
2581 u_mode.flags &= ~DRM_MODE_FLAG_PIC_AR_MASK;
2582 if (copy_to_user(mode_ptr + copied,
2583 &u_mode, sizeof(u_mode))) {
2587 * Clear the tag for the rest of
2588 * the modes for the next time around.
2590 list_for_each_entry_continue(mode, &connector->modes, head)
2591 mode->expose_to_userspace = false;
2593 mutex_unlock(&dev->mode_config.mutex);
2600 /* Clear the tag for the next time around */
2601 list_for_each_entry(mode, &connector->modes, head)
2602 mode->expose_to_userspace = false;
2605 out_resp->count_modes = mode_count;
2606 mutex_unlock(&dev->mode_config.mutex);
2608 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2609 encoder = drm_connector_get_encoder(connector);
2611 out_resp->encoder_id = encoder->base.id;
2613 out_resp->encoder_id = 0;
2615 /* Only grab properties after probing, to make sure EDID and other
2616 * properties reflect the latest status.
2618 ret = drm_mode_object_get_properties(&connector->base, file_priv->atomic,
2619 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
2620 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
2621 &out_resp->count_props);
2622 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2625 drm_connector_put(connector);
2634 * Tile groups are used to represent tiled monitors with a unique integer
2635 * identifier. Tiled monitors using DisplayID v1.3 have a unique 8-byte handle,
2636 * we store this in a tile group, so we have a common identifier for all tiles
2637 * in a monitor group. The property is called "TILE". Drivers can manage tile
2638 * groups using drm_mode_create_tile_group(), drm_mode_put_tile_group() and
2639 * drm_mode_get_tile_group(). But this is only needed for internal panels where
2640 * the tile group information is exposed through a non-standard way.
2643 static void drm_tile_group_free(struct kref *kref)
2645 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
2646 struct drm_device *dev = tg->dev;
2648 mutex_lock(&dev->mode_config.idr_mutex);
2649 idr_remove(&dev->mode_config.tile_idr, tg->id);
2650 mutex_unlock(&dev->mode_config.idr_mutex);
2655 * drm_mode_put_tile_group - drop a reference to a tile group.
2657 * @tg: tile group to drop reference to.
2659 * drop reference to tile group and free if 0.
2661 void drm_mode_put_tile_group(struct drm_device *dev,
2662 struct drm_tile_group *tg)
2664 kref_put(&tg->refcount, drm_tile_group_free);
2666 EXPORT_SYMBOL(drm_mode_put_tile_group);
2669 * drm_mode_get_tile_group - get a reference to an existing tile group
2671 * @topology: 8-bytes unique per monitor.
2673 * Use the unique bytes to get a reference to an existing tile group.
2676 * tile group or NULL if not found.
2678 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
2679 const char topology[8])
2681 struct drm_tile_group *tg;
2684 mutex_lock(&dev->mode_config.idr_mutex);
2685 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
2686 if (!memcmp(tg->group_data, topology, 8)) {
2687 if (!kref_get_unless_zero(&tg->refcount))
2689 mutex_unlock(&dev->mode_config.idr_mutex);
2693 mutex_unlock(&dev->mode_config.idr_mutex);
2696 EXPORT_SYMBOL(drm_mode_get_tile_group);
2699 * drm_mode_create_tile_group - create a tile group from a displayid description
2701 * @topology: 8-bytes unique per monitor.
2703 * Create a tile group for the unique monitor, and get a unique
2704 * identifier for the tile group.
2707 * new tile group or NULL.
2709 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
2710 const char topology[8])
2712 struct drm_tile_group *tg;
2715 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
2719 kref_init(&tg->refcount);
2720 memcpy(tg->group_data, topology, 8);
2723 mutex_lock(&dev->mode_config.idr_mutex);
2724 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
2732 mutex_unlock(&dev->mode_config.idr_mutex);
2735 EXPORT_SYMBOL(drm_mode_create_tile_group);