2 * Copyright (c) 2016 Intel Corporation
4 * Permission to use, copy, modify, distribute, and sell this software and its
5 * documentation for any purpose is hereby granted without fee, provided that
6 * the above copyright notice appear in all copies and that both that copyright
7 * notice and this permission notice appear in supporting documentation, and
8 * that the name of the copyright holders not be used in advertising or
9 * publicity pertaining to distribution of the software without specific,
10 * written prior permission. The copyright holders make no representations
11 * about the suitability of this software for any purpose. It is provided "as
12 * is" without express or implied warranty.
14 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
23 #include <drm/drm_connector.h>
24 #include <drm/drm_edid.h>
25 #include <drm/drm_encoder.h>
26 #include <drm/drm_utils.h>
27 #include <drm/drm_print.h>
28 #include <drm/drm_drv.h>
29 #include <drm/drm_file.h>
31 #include <linux/uaccess.h>
33 #include "drm_crtc_internal.h"
34 #include "drm_internal.h"
39 * In DRM connectors are the general abstraction for display sinks, and include
40 * als fixed panels or anything else that can display pixels in some form. As
41 * opposed to all other KMS objects representing hardware (like CRTC, encoder or
42 * plane abstractions) connectors can be hotplugged and unplugged at runtime.
43 * Hence they are reference-counted using drm_connector_get() and
44 * drm_connector_put().
46 * KMS driver must create, initialize, register and attach at a &struct
47 * drm_connector for each such sink. The instance is created as other KMS
48 * objects and initialized by setting the following fields. The connector is
49 * initialized with a call to drm_connector_init() with a pointer to the
50 * &struct drm_connector_funcs and a connector type, and then exposed to
51 * userspace with a call to drm_connector_register().
53 * Connectors must be attached to an encoder to be used. For devices that map
54 * connectors to encoders 1:1, the connector should be attached at
55 * initialization time with a call to drm_connector_attach_encoder(). The
56 * driver must also set the &drm_connector.encoder field to point to the
59 * For connectors which are not fixed (like built-in panels) the driver needs to
60 * support hotplug notifications. The simplest way to do that is by using the
61 * probe helpers, see drm_kms_helper_poll_init() for connectors which don't have
62 * hardware support for hotplug interrupts. Connectors with hardware hotplug
63 * support can instead use e.g. drm_helper_hpd_irq_event().
66 struct drm_conn_prop_enum_list {
73 * Connector and encoder types.
75 static struct drm_conn_prop_enum_list drm_connector_enum_list[] = {
76 { DRM_MODE_CONNECTOR_Unknown, "Unknown" },
77 { DRM_MODE_CONNECTOR_VGA, "VGA" },
78 { DRM_MODE_CONNECTOR_DVII, "DVI-I" },
79 { DRM_MODE_CONNECTOR_DVID, "DVI-D" },
80 { DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
81 { DRM_MODE_CONNECTOR_Composite, "Composite" },
82 { DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
83 { DRM_MODE_CONNECTOR_LVDS, "LVDS" },
84 { DRM_MODE_CONNECTOR_Component, "Component" },
85 { DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
86 { DRM_MODE_CONNECTOR_DisplayPort, "DP" },
87 { DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
88 { DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
89 { DRM_MODE_CONNECTOR_TV, "TV" },
90 { DRM_MODE_CONNECTOR_eDP, "eDP" },
91 { DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
92 { DRM_MODE_CONNECTOR_DSI, "DSI" },
93 { DRM_MODE_CONNECTOR_DPI, "DPI" },
94 { DRM_MODE_CONNECTOR_WRITEBACK, "Writeback" },
95 { DRM_MODE_CONNECTOR_SPI, "SPI" },
98 void drm_connector_ida_init(void)
102 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
103 ida_init(&drm_connector_enum_list[i].ida);
106 void drm_connector_ida_destroy(void)
110 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
111 ida_destroy(&drm_connector_enum_list[i].ida);
115 * drm_get_connector_type_name - return a string for connector type
116 * @type: The connector type (DRM_MODE_CONNECTOR_*)
118 * Returns: the name of the connector type, or NULL if the type is not valid.
120 const char *drm_get_connector_type_name(unsigned int type)
122 if (type < ARRAY_SIZE(drm_connector_enum_list))
123 return drm_connector_enum_list[type].name;
127 EXPORT_SYMBOL(drm_get_connector_type_name);
130 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
131 * @connector: connector to quwery
133 * The kernel supports per-connector configuration of its consoles through
134 * use of the video= parameter. This function parses that option and
135 * extracts the user's specified mode (or enable/disable status) for a
136 * particular connector. This is typically only used during the early fbdev
139 static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
141 struct drm_cmdline_mode *mode = &connector->cmdline_mode;
144 if (fb_get_options(connector->name, &option))
147 if (!drm_mode_parse_command_line_for_connector(option,
153 DRM_INFO("forcing %s connector %s\n", connector->name,
154 drm_get_connector_force_name(mode->force));
155 connector->force = mode->force;
158 if (mode->panel_orientation != DRM_MODE_PANEL_ORIENTATION_UNKNOWN) {
159 DRM_INFO("cmdline forces connector %s panel_orientation to %d\n",
160 connector->name, mode->panel_orientation);
161 drm_connector_set_panel_orientation(connector,
162 mode->panel_orientation);
165 DRM_DEBUG_KMS("cmdline mode for connector %s %s %dx%d@%dHz%s%s%s\n",
166 connector->name, mode->name,
167 mode->xres, mode->yres,
168 mode->refresh_specified ? mode->refresh : 60,
169 mode->rb ? " reduced blanking" : "",
170 mode->margins ? " with margins" : "",
171 mode->interlace ? " interlaced" : "");
174 static void drm_connector_free(struct kref *kref)
176 struct drm_connector *connector =
177 container_of(kref, struct drm_connector, base.refcount);
178 struct drm_device *dev = connector->dev;
180 drm_mode_object_unregister(dev, &connector->base);
181 connector->funcs->destroy(connector);
184 void drm_connector_free_work_fn(struct work_struct *work)
186 struct drm_connector *connector, *n;
187 struct drm_device *dev =
188 container_of(work, struct drm_device, mode_config.connector_free_work);
189 struct drm_mode_config *config = &dev->mode_config;
191 struct llist_node *freed;
193 spin_lock_irqsave(&config->connector_list_lock, flags);
194 freed = llist_del_all(&config->connector_free_list);
195 spin_unlock_irqrestore(&config->connector_list_lock, flags);
197 llist_for_each_entry_safe(connector, n, freed, free_node) {
198 drm_mode_object_unregister(dev, &connector->base);
199 connector->funcs->destroy(connector);
204 * drm_connector_init - Init a preallocated connector
206 * @connector: the connector to init
207 * @funcs: callbacks for this connector
208 * @connector_type: user visible type of the connector
210 * Initialises a preallocated connector. Connectors should be
211 * subclassed as part of driver connector objects.
214 * Zero on success, error code on failure.
216 int drm_connector_init(struct drm_device *dev,
217 struct drm_connector *connector,
218 const struct drm_connector_funcs *funcs,
221 struct drm_mode_config *config = &dev->mode_config;
223 struct ida *connector_ida =
224 &drm_connector_enum_list[connector_type].ida;
226 WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
227 (!funcs->atomic_destroy_state ||
228 !funcs->atomic_duplicate_state));
230 ret = __drm_mode_object_add(dev, &connector->base,
231 DRM_MODE_OBJECT_CONNECTOR,
232 false, drm_connector_free);
236 connector->base.properties = &connector->properties;
237 connector->dev = dev;
238 connector->funcs = funcs;
240 /* connector index is used with 32bit bitmasks */
241 ret = ida_simple_get(&config->connector_ida, 0, 32, GFP_KERNEL);
243 DRM_DEBUG_KMS("Failed to allocate %s connector index: %d\n",
244 drm_connector_enum_list[connector_type].name,
248 connector->index = ret;
251 connector->connector_type = connector_type;
252 connector->connector_type_id =
253 ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
254 if (connector->connector_type_id < 0) {
255 ret = connector->connector_type_id;
259 kasprintf(GFP_KERNEL, "%s-%d",
260 drm_connector_enum_list[connector_type].name,
261 connector->connector_type_id);
262 if (!connector->name) {
264 goto out_put_type_id;
267 INIT_LIST_HEAD(&connector->probed_modes);
268 INIT_LIST_HEAD(&connector->modes);
269 mutex_init(&connector->mutex);
270 connector->edid_blob_ptr = NULL;
271 connector->tile_blob_ptr = NULL;
272 connector->status = connector_status_unknown;
273 connector->display_info.panel_orientation =
274 DRM_MODE_PANEL_ORIENTATION_UNKNOWN;
276 drm_connector_get_cmdline_mode(connector);
278 /* We should add connectors at the end to avoid upsetting the connector
280 spin_lock_irq(&config->connector_list_lock);
281 list_add_tail(&connector->head, &config->connector_list);
282 config->num_connector++;
283 spin_unlock_irq(&config->connector_list_lock);
285 if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL &&
286 connector_type != DRM_MODE_CONNECTOR_WRITEBACK)
287 drm_connector_attach_edid_property(connector);
289 drm_object_attach_property(&connector->base,
290 config->dpms_property, 0);
292 drm_object_attach_property(&connector->base,
293 config->link_status_property,
296 drm_object_attach_property(&connector->base,
297 config->non_desktop_property,
299 drm_object_attach_property(&connector->base,
300 config->tile_property,
303 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
304 drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
307 connector->debugfs_entry = NULL;
310 ida_simple_remove(connector_ida, connector->connector_type_id);
313 ida_simple_remove(&config->connector_ida, connector->index);
316 drm_mode_object_unregister(dev, &connector->base);
320 EXPORT_SYMBOL(drm_connector_init);
323 * drm_connector_init_with_ddc - Init a preallocated connector
325 * @connector: the connector to init
326 * @funcs: callbacks for this connector
327 * @connector_type: user visible type of the connector
328 * @ddc: pointer to the associated ddc adapter
330 * Initialises a preallocated connector. Connectors should be
331 * subclassed as part of driver connector objects.
333 * Ensures that the ddc field of the connector is correctly set.
336 * Zero on success, error code on failure.
338 int drm_connector_init_with_ddc(struct drm_device *dev,
339 struct drm_connector *connector,
340 const struct drm_connector_funcs *funcs,
342 struct i2c_adapter *ddc)
346 ret = drm_connector_init(dev, connector, funcs, connector_type);
350 /* provide ddc symlink in sysfs */
351 connector->ddc = ddc;
355 EXPORT_SYMBOL(drm_connector_init_with_ddc);
358 * drm_connector_attach_edid_property - attach edid property.
359 * @connector: the connector
361 * Some connector types like DRM_MODE_CONNECTOR_VIRTUAL do not get a
362 * edid property attached by default. This function can be used to
363 * explicitly enable the edid property in these cases.
365 void drm_connector_attach_edid_property(struct drm_connector *connector)
367 struct drm_mode_config *config = &connector->dev->mode_config;
369 drm_object_attach_property(&connector->base,
370 config->edid_property,
373 EXPORT_SYMBOL(drm_connector_attach_edid_property);
376 * drm_connector_attach_encoder - attach a connector to an encoder
377 * @connector: connector to attach
378 * @encoder: encoder to attach @connector to
380 * This function links up a connector to an encoder. Note that the routing
381 * restrictions between encoders and crtcs are exposed to userspace through the
382 * possible_clones and possible_crtcs bitmasks.
385 * Zero on success, negative errno on failure.
387 int drm_connector_attach_encoder(struct drm_connector *connector,
388 struct drm_encoder *encoder)
391 * In the past, drivers have attempted to model the static association
392 * of connector to encoder in simple connector/encoder devices using a
393 * direct assignment of connector->encoder = encoder. This connection
394 * is a logical one and the responsibility of the core, so drivers are
395 * expected not to mess with this.
397 * Note that the error return should've been enough here, but a large
398 * majority of drivers ignores the return value, so add in a big WARN
399 * to get people's attention.
401 if (WARN_ON(connector->encoder))
404 connector->possible_encoders |= drm_encoder_mask(encoder);
408 EXPORT_SYMBOL(drm_connector_attach_encoder);
411 * drm_connector_has_possible_encoder - check if the connector and encoder are
412 * associated with each other
413 * @connector: the connector
414 * @encoder: the encoder
417 * True if @encoder is one of the possible encoders for @connector.
419 bool drm_connector_has_possible_encoder(struct drm_connector *connector,
420 struct drm_encoder *encoder)
422 return connector->possible_encoders & drm_encoder_mask(encoder);
424 EXPORT_SYMBOL(drm_connector_has_possible_encoder);
426 static void drm_mode_remove(struct drm_connector *connector,
427 struct drm_display_mode *mode)
429 list_del(&mode->head);
430 drm_mode_destroy(connector->dev, mode);
434 * drm_connector_cleanup - cleans up an initialised connector
435 * @connector: connector to cleanup
437 * Cleans up the connector but doesn't free the object.
439 void drm_connector_cleanup(struct drm_connector *connector)
441 struct drm_device *dev = connector->dev;
442 struct drm_display_mode *mode, *t;
444 /* The connector should have been removed from userspace long before
445 * it is finally destroyed.
447 if (WARN_ON(connector->registration_state ==
448 DRM_CONNECTOR_REGISTERED))
449 drm_connector_unregister(connector);
451 if (connector->tile_group) {
452 drm_mode_put_tile_group(dev, connector->tile_group);
453 connector->tile_group = NULL;
456 list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
457 drm_mode_remove(connector, mode);
459 list_for_each_entry_safe(mode, t, &connector->modes, head)
460 drm_mode_remove(connector, mode);
462 ida_simple_remove(&drm_connector_enum_list[connector->connector_type].ida,
463 connector->connector_type_id);
465 ida_simple_remove(&dev->mode_config.connector_ida,
468 kfree(connector->display_info.bus_formats);
469 drm_mode_object_unregister(dev, &connector->base);
470 kfree(connector->name);
471 connector->name = NULL;
472 spin_lock_irq(&dev->mode_config.connector_list_lock);
473 list_del(&connector->head);
474 dev->mode_config.num_connector--;
475 spin_unlock_irq(&dev->mode_config.connector_list_lock);
477 WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
478 if (connector->state && connector->funcs->atomic_destroy_state)
479 connector->funcs->atomic_destroy_state(connector,
482 mutex_destroy(&connector->mutex);
484 memset(connector, 0, sizeof(*connector));
486 EXPORT_SYMBOL(drm_connector_cleanup);
489 * drm_connector_register - register a connector
490 * @connector: the connector to register
492 * Register userspace interfaces for a connector. Only call this for connectors
493 * which can be hotplugged after drm_dev_register() has been called already,
494 * e.g. DP MST connectors. All other connectors will be registered automatically
495 * when calling drm_dev_register().
498 * Zero on success, error code on failure.
500 int drm_connector_register(struct drm_connector *connector)
504 if (!connector->dev->registered)
507 mutex_lock(&connector->mutex);
508 if (connector->registration_state != DRM_CONNECTOR_INITIALIZING)
511 ret = drm_sysfs_connector_add(connector);
515 drm_debugfs_connector_add(connector);
517 if (connector->funcs->late_register) {
518 ret = connector->funcs->late_register(connector);
523 drm_mode_object_register(connector->dev, &connector->base);
525 connector->registration_state = DRM_CONNECTOR_REGISTERED;
529 drm_debugfs_connector_remove(connector);
530 drm_sysfs_connector_remove(connector);
532 mutex_unlock(&connector->mutex);
535 EXPORT_SYMBOL(drm_connector_register);
538 * drm_connector_unregister - unregister a connector
539 * @connector: the connector to unregister
541 * Unregister userspace interfaces for a connector. Only call this for
542 * connectors which have registered explicitly by calling drm_dev_register(),
543 * since connectors are unregistered automatically when drm_dev_unregister() is
546 void drm_connector_unregister(struct drm_connector *connector)
548 mutex_lock(&connector->mutex);
549 if (connector->registration_state != DRM_CONNECTOR_REGISTERED) {
550 mutex_unlock(&connector->mutex);
554 if (connector->funcs->early_unregister)
555 connector->funcs->early_unregister(connector);
557 drm_sysfs_connector_remove(connector);
558 drm_debugfs_connector_remove(connector);
560 connector->registration_state = DRM_CONNECTOR_UNREGISTERED;
561 mutex_unlock(&connector->mutex);
563 EXPORT_SYMBOL(drm_connector_unregister);
565 void drm_connector_unregister_all(struct drm_device *dev)
567 struct drm_connector *connector;
568 struct drm_connector_list_iter conn_iter;
570 drm_connector_list_iter_begin(dev, &conn_iter);
571 drm_for_each_connector_iter(connector, &conn_iter)
572 drm_connector_unregister(connector);
573 drm_connector_list_iter_end(&conn_iter);
576 int drm_connector_register_all(struct drm_device *dev)
578 struct drm_connector *connector;
579 struct drm_connector_list_iter conn_iter;
582 drm_connector_list_iter_begin(dev, &conn_iter);
583 drm_for_each_connector_iter(connector, &conn_iter) {
584 ret = drm_connector_register(connector);
588 drm_connector_list_iter_end(&conn_iter);
591 drm_connector_unregister_all(dev);
596 * drm_get_connector_status_name - return a string for connector status
597 * @status: connector status to compute name of
599 * In contrast to the other drm_get_*_name functions this one here returns a
600 * const pointer and hence is threadsafe.
602 const char *drm_get_connector_status_name(enum drm_connector_status status)
604 if (status == connector_status_connected)
606 else if (status == connector_status_disconnected)
607 return "disconnected";
611 EXPORT_SYMBOL(drm_get_connector_status_name);
614 * drm_get_connector_force_name - return a string for connector force
615 * @force: connector force to get name of
617 * Returns: const pointer to name.
619 const char *drm_get_connector_force_name(enum drm_connector_force force)
622 case DRM_FORCE_UNSPECIFIED:
623 return "unspecified";
628 case DRM_FORCE_ON_DIGITAL:
635 #ifdef CONFIG_LOCKDEP
636 static struct lockdep_map connector_list_iter_dep_map = {
637 .name = "drm_connector_list_iter"
642 * drm_connector_list_iter_begin - initialize a connector_list iterator
644 * @iter: connector_list iterator
646 * Sets @iter up to walk the &drm_mode_config.connector_list of @dev. @iter
647 * must always be cleaned up again by calling drm_connector_list_iter_end().
648 * Iteration itself happens using drm_connector_list_iter_next() or
649 * drm_for_each_connector_iter().
651 void drm_connector_list_iter_begin(struct drm_device *dev,
652 struct drm_connector_list_iter *iter)
656 lock_acquire_shared_recursive(&connector_list_iter_dep_map, 0, 1, NULL, _RET_IP_);
658 EXPORT_SYMBOL(drm_connector_list_iter_begin);
661 * Extra-safe connector put function that works in any context. Should only be
662 * used from the connector_iter functions, where we never really expect to
663 * actually release the connector when dropping our final reference.
666 __drm_connector_put_safe(struct drm_connector *conn)
668 struct drm_mode_config *config = &conn->dev->mode_config;
670 lockdep_assert_held(&config->connector_list_lock);
672 if (!refcount_dec_and_test(&conn->base.refcount.refcount))
675 llist_add(&conn->free_node, &config->connector_free_list);
676 schedule_work(&config->connector_free_work);
680 * drm_connector_list_iter_next - return next connector
681 * @iter: connector_list iterator
683 * Returns the next connector for @iter, or NULL when the list walk has
686 struct drm_connector *
687 drm_connector_list_iter_next(struct drm_connector_list_iter *iter)
689 struct drm_connector *old_conn = iter->conn;
690 struct drm_mode_config *config = &iter->dev->mode_config;
691 struct list_head *lhead;
694 spin_lock_irqsave(&config->connector_list_lock, flags);
695 lhead = old_conn ? &old_conn->head : &config->connector_list;
698 if (lhead->next == &config->connector_list) {
704 iter->conn = list_entry(lhead, struct drm_connector, head);
706 /* loop until it's not a zombie connector */
707 } while (!kref_get_unless_zero(&iter->conn->base.refcount));
710 __drm_connector_put_safe(old_conn);
711 spin_unlock_irqrestore(&config->connector_list_lock, flags);
715 EXPORT_SYMBOL(drm_connector_list_iter_next);
718 * drm_connector_list_iter_end - tear down a connector_list iterator
719 * @iter: connector_list iterator
721 * Tears down @iter and releases any resources (like &drm_connector references)
722 * acquired while walking the list. This must always be called, both when the
723 * iteration completes fully or when it was aborted without walking the entire
726 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter)
728 struct drm_mode_config *config = &iter->dev->mode_config;
733 spin_lock_irqsave(&config->connector_list_lock, flags);
734 __drm_connector_put_safe(iter->conn);
735 spin_unlock_irqrestore(&config->connector_list_lock, flags);
737 lock_release(&connector_list_iter_dep_map, _RET_IP_);
739 EXPORT_SYMBOL(drm_connector_list_iter_end);
741 static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
742 { SubPixelUnknown, "Unknown" },
743 { SubPixelHorizontalRGB, "Horizontal RGB" },
744 { SubPixelHorizontalBGR, "Horizontal BGR" },
745 { SubPixelVerticalRGB, "Vertical RGB" },
746 { SubPixelVerticalBGR, "Vertical BGR" },
747 { SubPixelNone, "None" },
751 * drm_get_subpixel_order_name - return a string for a given subpixel enum
752 * @order: enum of subpixel_order
754 * Note you could abuse this and return something out of bounds, but that
755 * would be a caller error. No unscrubbed user data should make it here.
757 const char *drm_get_subpixel_order_name(enum subpixel_order order)
759 return drm_subpixel_enum_list[order].name;
761 EXPORT_SYMBOL(drm_get_subpixel_order_name);
763 static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
764 { DRM_MODE_DPMS_ON, "On" },
765 { DRM_MODE_DPMS_STANDBY, "Standby" },
766 { DRM_MODE_DPMS_SUSPEND, "Suspend" },
767 { DRM_MODE_DPMS_OFF, "Off" }
769 DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
771 static const struct drm_prop_enum_list drm_link_status_enum_list[] = {
772 { DRM_MODE_LINK_STATUS_GOOD, "Good" },
773 { DRM_MODE_LINK_STATUS_BAD, "Bad" },
777 * drm_display_info_set_bus_formats - set the supported bus formats
778 * @info: display info to store bus formats in
779 * @formats: array containing the supported bus formats
780 * @num_formats: the number of entries in the fmts array
782 * Store the supported bus formats in display info structure.
783 * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
784 * a full list of available formats.
786 int drm_display_info_set_bus_formats(struct drm_display_info *info,
788 unsigned int num_formats)
792 if (!formats && num_formats)
795 if (formats && num_formats) {
796 fmts = kmemdup(formats, sizeof(*formats) * num_formats,
802 kfree(info->bus_formats);
803 info->bus_formats = fmts;
804 info->num_bus_formats = num_formats;
808 EXPORT_SYMBOL(drm_display_info_set_bus_formats);
810 /* Optional connector properties. */
811 static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
812 { DRM_MODE_SCALE_NONE, "None" },
813 { DRM_MODE_SCALE_FULLSCREEN, "Full" },
814 { DRM_MODE_SCALE_CENTER, "Center" },
815 { DRM_MODE_SCALE_ASPECT, "Full aspect" },
818 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
819 { DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
820 { DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
821 { DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
824 static const struct drm_prop_enum_list drm_content_type_enum_list[] = {
825 { DRM_MODE_CONTENT_TYPE_NO_DATA, "No Data" },
826 { DRM_MODE_CONTENT_TYPE_GRAPHICS, "Graphics" },
827 { DRM_MODE_CONTENT_TYPE_PHOTO, "Photo" },
828 { DRM_MODE_CONTENT_TYPE_CINEMA, "Cinema" },
829 { DRM_MODE_CONTENT_TYPE_GAME, "Game" },
832 static const struct drm_prop_enum_list drm_panel_orientation_enum_list[] = {
833 { DRM_MODE_PANEL_ORIENTATION_NORMAL, "Normal" },
834 { DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP, "Upside Down" },
835 { DRM_MODE_PANEL_ORIENTATION_LEFT_UP, "Left Side Up" },
836 { DRM_MODE_PANEL_ORIENTATION_RIGHT_UP, "Right Side Up" },
839 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
840 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
841 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
842 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
844 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
846 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
847 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
848 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
849 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
851 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
852 drm_dvi_i_subconnector_enum_list)
854 static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
855 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
856 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
857 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
858 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
859 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
861 DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
863 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
864 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
865 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
866 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
867 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
868 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
870 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
871 drm_tv_subconnector_enum_list)
873 static const struct drm_prop_enum_list hdmi_colorspaces[] = {
874 /* For Default case, driver will set the colorspace */
875 { DRM_MODE_COLORIMETRY_DEFAULT, "Default" },
876 /* Standard Definition Colorimetry based on CEA 861 */
877 { DRM_MODE_COLORIMETRY_SMPTE_170M_YCC, "SMPTE_170M_YCC" },
878 { DRM_MODE_COLORIMETRY_BT709_YCC, "BT709_YCC" },
879 /* Standard Definition Colorimetry based on IEC 61966-2-4 */
880 { DRM_MODE_COLORIMETRY_XVYCC_601, "XVYCC_601" },
881 /* High Definition Colorimetry based on IEC 61966-2-4 */
882 { DRM_MODE_COLORIMETRY_XVYCC_709, "XVYCC_709" },
883 /* Colorimetry based on IEC 61966-2-1/Amendment 1 */
884 { DRM_MODE_COLORIMETRY_SYCC_601, "SYCC_601" },
885 /* Colorimetry based on IEC 61966-2-5 [33] */
886 { DRM_MODE_COLORIMETRY_OPYCC_601, "opYCC_601" },
887 /* Colorimetry based on IEC 61966-2-5 */
888 { DRM_MODE_COLORIMETRY_OPRGB, "opRGB" },
889 /* Colorimetry based on ITU-R BT.2020 */
890 { DRM_MODE_COLORIMETRY_BT2020_CYCC, "BT2020_CYCC" },
891 /* Colorimetry based on ITU-R BT.2020 */
892 { DRM_MODE_COLORIMETRY_BT2020_RGB, "BT2020_RGB" },
893 /* Colorimetry based on ITU-R BT.2020 */
894 { DRM_MODE_COLORIMETRY_BT2020_YCC, "BT2020_YCC" },
895 /* Added as part of Additional Colorimetry Extension in 861.G */
896 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65, "DCI-P3_RGB_D65" },
897 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER, "DCI-P3_RGB_Theater" },
901 * As per DP 1.4a spec, 2.2.5.7.5 VSC SDP Payload for Pixel Encoding/Colorimetry
904 static const struct drm_prop_enum_list dp_colorspaces[] = {
905 /* For Default case, driver will set the colorspace */
906 { DRM_MODE_COLORIMETRY_DEFAULT, "Default" },
907 { DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED, "RGB_Wide_Gamut_Fixed_Point" },
908 /* Colorimetry based on scRGB (IEC 61966-2-2) */
909 { DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT, "RGB_Wide_Gamut_Floating_Point" },
910 /* Colorimetry based on IEC 61966-2-5 */
911 { DRM_MODE_COLORIMETRY_OPRGB, "opRGB" },
912 /* Colorimetry based on SMPTE RP 431-2 */
913 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65, "DCI-P3_RGB_D65" },
914 /* Colorimetry based on ITU-R BT.2020 */
915 { DRM_MODE_COLORIMETRY_BT2020_RGB, "BT2020_RGB" },
916 { DRM_MODE_COLORIMETRY_BT601_YCC, "BT601_YCC" },
917 { DRM_MODE_COLORIMETRY_BT709_YCC, "BT709_YCC" },
918 /* Standard Definition Colorimetry based on IEC 61966-2-4 */
919 { DRM_MODE_COLORIMETRY_XVYCC_601, "XVYCC_601" },
920 /* High Definition Colorimetry based on IEC 61966-2-4 */
921 { DRM_MODE_COLORIMETRY_XVYCC_709, "XVYCC_709" },
922 /* Colorimetry based on IEC 61966-2-1/Amendment 1 */
923 { DRM_MODE_COLORIMETRY_SYCC_601, "SYCC_601" },
924 /* Colorimetry based on IEC 61966-2-5 [33] */
925 { DRM_MODE_COLORIMETRY_OPYCC_601, "opYCC_601" },
926 /* Colorimetry based on ITU-R BT.2020 */
927 { DRM_MODE_COLORIMETRY_BT2020_CYCC, "BT2020_CYCC" },
928 /* Colorimetry based on ITU-R BT.2020 */
929 { DRM_MODE_COLORIMETRY_BT2020_YCC, "BT2020_YCC" },
933 * DOC: standard connector properties
935 * DRM connectors have a few standardized properties:
938 * Blob property which contains the current EDID read from the sink. This
939 * is useful to parse sink identification information like vendor, model
940 * and serial. Drivers should update this property by calling
941 * drm_connector_update_edid_property(), usually after having parsed
942 * the EDID using drm_add_edid_modes(). Userspace cannot change this
945 * Legacy property for setting the power state of the connector. For atomic
946 * drivers this is only provided for backwards compatibility with existing
947 * drivers, it remaps to controlling the "ACTIVE" property on the CRTC the
948 * connector is linked to. Drivers should never set this property directly,
949 * it is handled by the DRM core by calling the &drm_connector_funcs.dpms
950 * callback. For atomic drivers the remapping to the "ACTIVE" property is
951 * implemented in the DRM core.
953 * Note that this property cannot be set through the MODE_ATOMIC ioctl,
954 * userspace must use "ACTIVE" on the CRTC instead.
958 * For userspace also running on legacy drivers the "DPMS" semantics are a
959 * lot more complicated. First, userspace cannot rely on the "DPMS" value
960 * returned by the GETCONNECTOR actually reflecting reality, because many
961 * drivers fail to update it. For atomic drivers this is taken care of in
962 * drm_atomic_helper_update_legacy_modeset_state().
964 * The second issue is that the DPMS state is only well-defined when the
965 * connector is connected to a CRTC. In atomic the DRM core enforces that
966 * "ACTIVE" is off in such a case, no such checks exists for "DPMS".
968 * Finally, when enabling an output using the legacy SETCONFIG ioctl then
969 * "DPMS" is forced to ON. But see above, that might not be reflected in
970 * the software value on legacy drivers.
972 * Summarizing: Only set "DPMS" when the connector is known to be enabled,
973 * assume that a successful SETCONFIG call also sets "DPMS" to on, and
974 * never read back the value of "DPMS" because it can be incorrect.
976 * Connector path property to identify how this sink is physically
977 * connected. Used by DP MST. This should be set by calling
978 * drm_connector_set_path_property(), in the case of DP MST with the
979 * path property the MST manager created. Userspace cannot change this
982 * Connector tile group property to indicate how a set of DRM connector
983 * compose together into one logical screen. This is used by both high-res
984 * external screens (often only using a single cable, but exposing multiple
985 * DP MST sinks), or high-res integrated panels (like dual-link DSI) which
986 * are not gen-locked. Note that for tiled panels which are genlocked, like
987 * dual-link LVDS or dual-link DSI, the driver should try to not expose the
988 * tiling and virtualize both &drm_crtc and &drm_plane if needed. Drivers
989 * should update this value using drm_connector_set_tile_property().
990 * Userspace cannot change this property.
992 * Connector link-status property to indicate the status of link. The
993 * default value of link-status is "GOOD". If something fails during or
994 * after modeset, the kernel driver may set this to "BAD" and issue a
995 * hotplug uevent. Drivers should update this value using
996 * drm_connector_set_link_status_property().
998 * When user-space receives the hotplug uevent and detects a "BAD"
999 * link-status, the sink doesn't receive pixels anymore (e.g. the screen
1000 * becomes completely black). The list of available modes may have
1001 * changed. User-space is expected to pick a new mode if the current one
1002 * has disappeared and perform a new modeset with link-status set to
1003 * "GOOD" to re-enable the connector.
1005 * If multiple connectors share the same CRTC and one of them gets a "BAD"
1006 * link-status, the other are unaffected (ie. the sinks still continue to
1009 * When user-space performs an atomic commit on a connector with a "BAD"
1010 * link-status without resetting the property to "GOOD", the sink may
1011 * still not receive pixels. When user-space performs an atomic commit
1012 * which resets the link-status property to "GOOD" without the
1013 * ALLOW_MODESET flag set, it might fail because a modeset is required.
1015 * User-space can only change link-status to "GOOD", changing it to "BAD"
1018 * For backwards compatibility with non-atomic userspace the kernel
1019 * tries to automatically set the link-status back to "GOOD" in the
1020 * SETCRTC IOCTL. This might fail if the mode is no longer valid, similar
1021 * to how it might fail if a different screen has been connected in the
1024 * Indicates the output should be ignored for purposes of displaying a
1025 * standard desktop environment or console. This is most likely because
1026 * the output device is not rectilinear.
1027 * Content Protection:
1028 * This property is used by userspace to request the kernel protect future
1029 * content communicated over the link. When requested, kernel will apply
1030 * the appropriate means of protection (most often HDCP), and use the
1031 * property to tell userspace the protection is active.
1033 * Drivers can set this up by calling
1034 * drm_connector_attach_content_protection_property() on initialization.
1036 * The value of this property can be one of the following:
1038 * DRM_MODE_CONTENT_PROTECTION_UNDESIRED = 0
1039 * The link is not protected, content is transmitted in the clear.
1040 * DRM_MODE_CONTENT_PROTECTION_DESIRED = 1
1041 * Userspace has requested content protection, but the link is not
1042 * currently protected. When in this state, kernel should enable
1043 * Content Protection as soon as possible.
1044 * DRM_MODE_CONTENT_PROTECTION_ENABLED = 2
1045 * Userspace has requested content protection, and the link is
1046 * protected. Only the driver can set the property to this value.
1047 * If userspace attempts to set to ENABLED, kernel will return
1052 * - DESIRED state should be preserved until userspace de-asserts it by
1053 * setting the property to UNDESIRED. This means ENABLED should only
1054 * transition to UNDESIRED when the user explicitly requests it.
1055 * - If the state is DESIRED, kernel should attempt to re-authenticate the
1056 * link whenever possible. This includes across disable/enable, dpms,
1057 * hotplug, downstream device changes, link status failures, etc..
1058 * - Kernel sends uevent with the connector id and property id through
1059 * @drm_hdcp_update_content_protection, upon below kernel triggered
1062 * - DESIRED -> ENABLED (authentication success)
1063 * - ENABLED -> DESIRED (termination of authentication)
1064 * - Please note no uevents for userspace triggered property state changes,
1065 * which can't fail such as
1067 * - DESIRED/ENABLED -> UNDESIRED
1068 * - UNDESIRED -> DESIRED
1069 * - Userspace is responsible for polling the property or listen to uevents
1070 * to determine when the value transitions from ENABLED to DESIRED.
1071 * This signifies the link is no longer protected and userspace should
1072 * take appropriate action (whatever that might be).
1074 * HDCP Content Type:
1075 * This Enum property is used by the userspace to declare the content type
1076 * of the display stream, to kernel. Here display stream stands for any
1077 * display content that userspace intended to display through HDCP
1080 * Content Type of a stream is decided by the owner of the stream, as
1081 * "HDCP Type0" or "HDCP Type1".
1083 * The value of the property can be one of the below:
1084 * - "HDCP Type0": DRM_MODE_HDCP_CONTENT_TYPE0 = 0
1085 * - "HDCP Type1": DRM_MODE_HDCP_CONTENT_TYPE1 = 1
1087 * When kernel starts the HDCP authentication (see "Content Protection"
1088 * for details), it uses the content type in "HDCP Content Type"
1089 * for performing the HDCP authentication with the display sink.
1091 * Please note in HDCP spec versions, a link can be authenticated with
1092 * HDCP 2.2 for Content Type 0/Content Type 1. Where as a link can be
1093 * authenticated with HDCP1.4 only for Content Type 0(though it is implicit
1094 * in nature. As there is no reference for Content Type in HDCP1.4).
1096 * HDCP2.2 authentication protocol itself takes the "Content Type" as a
1097 * parameter, which is a input for the DP HDCP2.2 encryption algo.
1099 * In case of Type 0 content protection request, kernel driver can choose
1100 * either of HDCP spec versions 1.4 and 2.2. When HDCP2.2 is used for
1101 * "HDCP Type 0", a HDCP 2.2 capable repeater in the downstream can send
1102 * that content to a HDCP 1.4 authenticated HDCP sink (Type0 link).
1103 * But if the content is classified as "HDCP Type 1", above mentioned
1104 * HDCP 2.2 repeater wont send the content to the HDCP sink as it can't
1105 * authenticate the HDCP1.4 capable sink for "HDCP Type 1".
1107 * Please note userspace can be ignorant of the HDCP versions used by the
1108 * kernel driver to achieve the "HDCP Content Type".
1110 * At current scenario, classifying a content as Type 1 ensures that the
1111 * content will be displayed only through the HDCP2.2 encrypted link.
1113 * Note that the HDCP Content Type property is introduced at HDCP 2.2, and
1114 * defaults to type 0. It is only exposed by drivers supporting HDCP 2.2
1115 * (hence supporting Type 0 and Type 1). Based on how next versions of
1116 * HDCP specs are defined content Type could be used for higher versions
1119 * If content type is changed when "Content Protection" is not UNDESIRED,
1120 * then kernel will disable the HDCP and re-enable with new type in the
1121 * same atomic commit. And when "Content Protection" is ENABLED, it means
1122 * that link is HDCP authenticated and encrypted, for the transmission of
1123 * the Type of stream mentioned at "HDCP Content Type".
1125 * HDR_OUTPUT_METADATA:
1126 * Connector property to enable userspace to send HDR Metadata to
1127 * driver. This metadata is based on the composition and blending
1128 * policies decided by user, taking into account the hardware and
1129 * sink capabilities. The driver gets this metadata and creates a
1130 * Dynamic Range and Mastering Infoframe (DRM) in case of HDMI,
1131 * SDP packet (Non-audio INFOFRAME SDP v1.3) for DP. This is then
1132 * sent to sink. This notifies the sink of the upcoming frame's Color
1133 * Encoding and Luminance parameters.
1135 * Userspace first need to detect the HDR capabilities of sink by
1136 * reading and parsing the EDID. Details of HDR metadata for HDMI
1137 * are added in CTA 861.G spec. For DP , its defined in VESA DP
1138 * Standard v1.4. It needs to then get the metadata information
1139 * of the video/game/app content which are encoded in HDR (basically
1140 * using HDR transfer functions). With this information it needs to
1141 * decide on a blending policy and compose the relevant
1142 * layers/overlays into a common format. Once this blending is done,
1143 * userspace will be aware of the metadata of the composed frame to
1144 * be send to sink. It then uses this property to communicate this
1145 * metadata to driver which then make a Infoframe packet and sends
1146 * to sink based on the type of encoder connected.
1148 * Userspace will be responsible to do Tone mapping operation in case:
1149 * - Some layers are HDR and others are SDR
1150 * - HDR layers luminance is not same as sink
1152 * It will even need to do colorspace conversion and get all layers
1153 * to one common colorspace for blending. It can use either GL, Media
1154 * or display engine to get this done based on the capabilties of the
1155 * associated hardware.
1157 * Driver expects metadata to be put in &struct hdr_output_metadata
1158 * structure from userspace. This is received as blob and stored in
1159 * &drm_connector_state.hdr_output_metadata. It parses EDID and saves the
1160 * sink metadata in &struct hdr_sink_metadata, as
1161 * &drm_connector.hdr_sink_metadata. Driver uses
1162 * drm_hdmi_infoframe_set_hdr_metadata() helper to set the HDR metadata,
1163 * hdmi_drm_infoframe_pack() to pack the infoframe as per spec, in case of
1167 * This range property is used by userspace to limit the bit depth. When
1168 * used the driver would limit the bpc in accordance with the valid range
1169 * supported by the hardware and sink. Drivers to use the function
1170 * drm_connector_attach_max_bpc_property() to create and attach the
1171 * property to the connector during initialization.
1173 * Connectors also have one standardized atomic property:
1176 * Mode object ID of the &drm_crtc this connector should be connected to.
1178 * Connectors for LCD panels may also have one standardized property:
1180 * panel orientation:
1181 * On some devices the LCD panel is mounted in the casing in such a way
1182 * that the up/top side of the panel does not match with the top side of
1183 * the device. Userspace can use this property to check for this.
1184 * Note that input coordinates from touchscreens (input devices with
1185 * INPUT_PROP_DIRECT) will still map 1:1 to the actual LCD panel
1186 * coordinates, so if userspace rotates the picture to adjust for
1187 * the orientation it must also apply the same transformation to the
1188 * touchscreen input coordinates. This property is initialized by calling
1189 * drm_connector_set_panel_orientation() or
1190 * drm_connector_set_panel_orientation_with_quirk()
1193 * This property defines how a non-native mode is upscaled to the native
1194 * mode of an LCD panel:
1197 * No upscaling happens, scaling is left to the panel. Not all
1198 * drivers expose this mode.
1200 * The output is upscaled to the full resolution of the panel,
1201 * ignoring the aspect ratio.
1203 * No upscaling happens, the output is centered within the native
1204 * resolution the panel.
1206 * The output is upscaled to maximize either the width or height
1207 * while retaining the aspect ratio.
1209 * This property should be set up by calling
1210 * drm_connector_attach_scaling_mode_property(). Note that drivers
1211 * can also expose this property to external outputs, in which case they
1212 * must support "None", which should be the default (since external screens
1213 * have a built-in scaler).
1216 int drm_connector_create_standard_properties(struct drm_device *dev)
1218 struct drm_property *prop;
1220 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1221 DRM_MODE_PROP_IMMUTABLE,
1225 dev->mode_config.edid_property = prop;
1227 prop = drm_property_create_enum(dev, 0,
1228 "DPMS", drm_dpms_enum_list,
1229 ARRAY_SIZE(drm_dpms_enum_list));
1232 dev->mode_config.dpms_property = prop;
1234 prop = drm_property_create(dev,
1235 DRM_MODE_PROP_BLOB |
1236 DRM_MODE_PROP_IMMUTABLE,
1240 dev->mode_config.path_property = prop;
1242 prop = drm_property_create(dev,
1243 DRM_MODE_PROP_BLOB |
1244 DRM_MODE_PROP_IMMUTABLE,
1248 dev->mode_config.tile_property = prop;
1250 prop = drm_property_create_enum(dev, 0, "link-status",
1251 drm_link_status_enum_list,
1252 ARRAY_SIZE(drm_link_status_enum_list));
1255 dev->mode_config.link_status_property = prop;
1257 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE, "non-desktop");
1260 dev->mode_config.non_desktop_property = prop;
1262 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB,
1263 "HDR_OUTPUT_METADATA", 0);
1266 dev->mode_config.hdr_output_metadata_property = prop;
1272 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1275 * Called by a driver the first time a DVI-I connector is made.
1277 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1279 struct drm_property *dvi_i_selector;
1280 struct drm_property *dvi_i_subconnector;
1282 if (dev->mode_config.dvi_i_select_subconnector_property)
1286 drm_property_create_enum(dev, 0,
1287 "select subconnector",
1288 drm_dvi_i_select_enum_list,
1289 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1290 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1292 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1294 drm_dvi_i_subconnector_enum_list,
1295 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1296 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1300 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1303 * DOC: HDMI connector properties
1305 * content type (HDMI specific):
1306 * Indicates content type setting to be used in HDMI infoframes to indicate
1307 * content type for the external device, so that it adjusts its display
1308 * settings accordingly.
1310 * The value of this property can be one of the following:
1313 * Content type is unknown
1315 * Content type is graphics
1317 * Content type is photo
1319 * Content type is cinema
1321 * Content type is game
1323 * Drivers can set up this property by calling
1324 * drm_connector_attach_content_type_property(). Decoding to
1325 * infoframe values is done through drm_hdmi_avi_infoframe_content_type().
1329 * drm_connector_attach_content_type_property - attach content-type property
1330 * @connector: connector to attach content type property on.
1332 * Called by a driver the first time a HDMI connector is made.
1334 int drm_connector_attach_content_type_property(struct drm_connector *connector)
1336 if (!drm_mode_create_content_type_property(connector->dev))
1337 drm_object_attach_property(&connector->base,
1338 connector->dev->mode_config.content_type_property,
1339 DRM_MODE_CONTENT_TYPE_NO_DATA);
1342 EXPORT_SYMBOL(drm_connector_attach_content_type_property);
1346 * drm_hdmi_avi_infoframe_content_type() - fill the HDMI AVI infoframe
1347 * content type information, based
1348 * on correspondent DRM property.
1349 * @frame: HDMI AVI infoframe
1350 * @conn_state: DRM display connector state
1353 void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
1354 const struct drm_connector_state *conn_state)
1356 switch (conn_state->content_type) {
1357 case DRM_MODE_CONTENT_TYPE_GRAPHICS:
1358 frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1360 case DRM_MODE_CONTENT_TYPE_CINEMA:
1361 frame->content_type = HDMI_CONTENT_TYPE_CINEMA;
1363 case DRM_MODE_CONTENT_TYPE_GAME:
1364 frame->content_type = HDMI_CONTENT_TYPE_GAME;
1366 case DRM_MODE_CONTENT_TYPE_PHOTO:
1367 frame->content_type = HDMI_CONTENT_TYPE_PHOTO;
1370 /* Graphics is the default(0) */
1371 frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1374 frame->itc = conn_state->content_type != DRM_MODE_CONTENT_TYPE_NO_DATA;
1376 EXPORT_SYMBOL(drm_hdmi_avi_infoframe_content_type);
1379 * drm_mode_attach_tv_margin_properties - attach TV connector margin properties
1380 * @connector: DRM connector
1382 * Called by a driver when it needs to attach TV margin props to a connector.
1383 * Typically used on SDTV and HDMI connectors.
1385 void drm_connector_attach_tv_margin_properties(struct drm_connector *connector)
1387 struct drm_device *dev = connector->dev;
1389 drm_object_attach_property(&connector->base,
1390 dev->mode_config.tv_left_margin_property,
1392 drm_object_attach_property(&connector->base,
1393 dev->mode_config.tv_right_margin_property,
1395 drm_object_attach_property(&connector->base,
1396 dev->mode_config.tv_top_margin_property,
1398 drm_object_attach_property(&connector->base,
1399 dev->mode_config.tv_bottom_margin_property,
1402 EXPORT_SYMBOL(drm_connector_attach_tv_margin_properties);
1405 * drm_mode_create_tv_margin_properties - create TV connector margin properties
1408 * Called by a driver's HDMI connector initialization routine, this function
1409 * creates the TV margin properties for a given device. No need to call this
1410 * function for an SDTV connector, it's already called from
1411 * drm_mode_create_tv_properties().
1413 int drm_mode_create_tv_margin_properties(struct drm_device *dev)
1415 if (dev->mode_config.tv_left_margin_property)
1418 dev->mode_config.tv_left_margin_property =
1419 drm_property_create_range(dev, 0, "left margin", 0, 100);
1420 if (!dev->mode_config.tv_left_margin_property)
1423 dev->mode_config.tv_right_margin_property =
1424 drm_property_create_range(dev, 0, "right margin", 0, 100);
1425 if (!dev->mode_config.tv_right_margin_property)
1428 dev->mode_config.tv_top_margin_property =
1429 drm_property_create_range(dev, 0, "top margin", 0, 100);
1430 if (!dev->mode_config.tv_top_margin_property)
1433 dev->mode_config.tv_bottom_margin_property =
1434 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1435 if (!dev->mode_config.tv_bottom_margin_property)
1440 EXPORT_SYMBOL(drm_mode_create_tv_margin_properties);
1443 * drm_mode_create_tv_properties - create TV specific connector properties
1445 * @num_modes: number of different TV formats (modes) supported
1446 * @modes: array of pointers to strings containing name of each format
1448 * Called by a driver's TV initialization routine, this function creates
1449 * the TV specific connector properties for a given device. Caller is
1450 * responsible for allocating a list of format names and passing them to
1453 int drm_mode_create_tv_properties(struct drm_device *dev,
1454 unsigned int num_modes,
1455 const char * const modes[])
1457 struct drm_property *tv_selector;
1458 struct drm_property *tv_subconnector;
1461 if (dev->mode_config.tv_select_subconnector_property)
1465 * Basic connector properties
1467 tv_selector = drm_property_create_enum(dev, 0,
1468 "select subconnector",
1469 drm_tv_select_enum_list,
1470 ARRAY_SIZE(drm_tv_select_enum_list));
1474 dev->mode_config.tv_select_subconnector_property = tv_selector;
1477 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1479 drm_tv_subconnector_enum_list,
1480 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1481 if (!tv_subconnector)
1483 dev->mode_config.tv_subconnector_property = tv_subconnector;
1486 * Other, TV specific properties: margins & TV modes.
1488 if (drm_mode_create_tv_margin_properties(dev))
1491 dev->mode_config.tv_mode_property =
1492 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1494 if (!dev->mode_config.tv_mode_property)
1497 for (i = 0; i < num_modes; i++)
1498 drm_property_add_enum(dev->mode_config.tv_mode_property,
1501 dev->mode_config.tv_brightness_property =
1502 drm_property_create_range(dev, 0, "brightness", 0, 100);
1503 if (!dev->mode_config.tv_brightness_property)
1506 dev->mode_config.tv_contrast_property =
1507 drm_property_create_range(dev, 0, "contrast", 0, 100);
1508 if (!dev->mode_config.tv_contrast_property)
1511 dev->mode_config.tv_flicker_reduction_property =
1512 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1513 if (!dev->mode_config.tv_flicker_reduction_property)
1516 dev->mode_config.tv_overscan_property =
1517 drm_property_create_range(dev, 0, "overscan", 0, 100);
1518 if (!dev->mode_config.tv_overscan_property)
1521 dev->mode_config.tv_saturation_property =
1522 drm_property_create_range(dev, 0, "saturation", 0, 100);
1523 if (!dev->mode_config.tv_saturation_property)
1526 dev->mode_config.tv_hue_property =
1527 drm_property_create_range(dev, 0, "hue", 0, 100);
1528 if (!dev->mode_config.tv_hue_property)
1535 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1538 * drm_mode_create_scaling_mode_property - create scaling mode property
1541 * Called by a driver the first time it's needed, must be attached to desired
1544 * Atomic drivers should use drm_connector_attach_scaling_mode_property()
1545 * instead to correctly assign &drm_connector_state.picture_aspect_ratio
1546 * in the atomic state.
1548 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1550 struct drm_property *scaling_mode;
1552 if (dev->mode_config.scaling_mode_property)
1556 drm_property_create_enum(dev, 0, "scaling mode",
1557 drm_scaling_mode_enum_list,
1558 ARRAY_SIZE(drm_scaling_mode_enum_list));
1560 dev->mode_config.scaling_mode_property = scaling_mode;
1564 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1567 * DOC: Variable refresh properties
1569 * Variable refresh rate capable displays can dynamically adjust their
1570 * refresh rate by extending the duration of their vertical front porch
1571 * until page flip or timeout occurs. This can reduce or remove stuttering
1572 * and latency in scenarios where the page flip does not align with the
1575 * An example scenario would be an application flipping at a constant rate
1576 * of 48Hz on a 60Hz display. The page flip will frequently miss the vblank
1577 * interval and the same contents will be displayed twice. This can be
1578 * observed as stuttering for content with motion.
1580 * If variable refresh rate was active on a display that supported a
1581 * variable refresh range from 35Hz to 60Hz no stuttering would be observable
1582 * for the example scenario. The minimum supported variable refresh rate of
1583 * 35Hz is below the page flip frequency and the vertical front porch can
1584 * be extended until the page flip occurs. The vblank interval will be
1585 * directly aligned to the page flip rate.
1587 * Not all userspace content is suitable for use with variable refresh rate.
1588 * Large and frequent changes in vertical front porch duration may worsen
1589 * perceived stuttering for input sensitive applications.
1591 * Panel brightness will also vary with vertical front porch duration. Some
1592 * panels may have noticeable differences in brightness between the minimum
1593 * vertical front porch duration and the maximum vertical front porch duration.
1594 * Large and frequent changes in vertical front porch duration may produce
1595 * observable flickering for such panels.
1597 * Userspace control for variable refresh rate is supported via properties
1598 * on the &drm_connector and &drm_crtc objects.
1601 * Optional &drm_connector boolean property that drivers should attach
1602 * with drm_connector_attach_vrr_capable_property() on connectors that
1603 * could support variable refresh rates. Drivers should update the
1604 * property value by calling drm_connector_set_vrr_capable_property().
1606 * Absence of the property should indicate absence of support.
1609 * Default &drm_crtc boolean property that notifies the driver that the
1610 * content on the CRTC is suitable for variable refresh rate presentation.
1611 * The driver will take this property as a hint to enable variable
1612 * refresh rate support if the receiver supports it, ie. if the
1613 * "vrr_capable" property is true on the &drm_connector object. The
1614 * vertical front porch duration will be extended until page-flip or
1615 * timeout when enabled.
1617 * The minimum vertical front porch duration is defined as the vertical
1618 * front porch duration for the current mode.
1620 * The maximum vertical front porch duration is greater than or equal to
1621 * the minimum vertical front porch duration. The duration is derived
1622 * from the minimum supported variable refresh rate for the connector.
1624 * The driver may place further restrictions within these minimum
1625 * and maximum bounds.
1629 * drm_connector_attach_vrr_capable_property - creates the
1630 * vrr_capable property
1631 * @connector: connector to create the vrr_capable property on.
1633 * This is used by atomic drivers to add support for querying
1634 * variable refresh rate capability for a connector.
1637 * Zero on success, negative errono on failure.
1639 int drm_connector_attach_vrr_capable_property(
1640 struct drm_connector *connector)
1642 struct drm_device *dev = connector->dev;
1643 struct drm_property *prop;
1645 if (!connector->vrr_capable_property) {
1646 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE,
1651 connector->vrr_capable_property = prop;
1652 drm_object_attach_property(&connector->base, prop, 0);
1657 EXPORT_SYMBOL(drm_connector_attach_vrr_capable_property);
1660 * drm_connector_attach_scaling_mode_property - attach atomic scaling mode property
1661 * @connector: connector to attach scaling mode property on.
1662 * @scaling_mode_mask: or'ed mask of BIT(%DRM_MODE_SCALE_\*).
1664 * This is used to add support for scaling mode to atomic drivers.
1665 * The scaling mode will be set to &drm_connector_state.picture_aspect_ratio
1666 * and can be used from &drm_connector_helper_funcs->atomic_check for validation.
1668 * This is the atomic version of drm_mode_create_scaling_mode_property().
1671 * Zero on success, negative errno on failure.
1673 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1674 u32 scaling_mode_mask)
1676 struct drm_device *dev = connector->dev;
1677 struct drm_property *scaling_mode_property;
1679 const unsigned valid_scaling_mode_mask =
1680 (1U << ARRAY_SIZE(drm_scaling_mode_enum_list)) - 1;
1682 if (WARN_ON(hweight32(scaling_mode_mask) < 2 ||
1683 scaling_mode_mask & ~valid_scaling_mode_mask))
1686 scaling_mode_property =
1687 drm_property_create(dev, DRM_MODE_PROP_ENUM, "scaling mode",
1688 hweight32(scaling_mode_mask));
1690 if (!scaling_mode_property)
1693 for (i = 0; i < ARRAY_SIZE(drm_scaling_mode_enum_list); i++) {
1696 if (!(BIT(i) & scaling_mode_mask))
1699 ret = drm_property_add_enum(scaling_mode_property,
1700 drm_scaling_mode_enum_list[i].type,
1701 drm_scaling_mode_enum_list[i].name);
1704 drm_property_destroy(dev, scaling_mode_property);
1710 drm_object_attach_property(&connector->base,
1711 scaling_mode_property, 0);
1713 connector->scaling_mode_property = scaling_mode_property;
1717 EXPORT_SYMBOL(drm_connector_attach_scaling_mode_property);
1720 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1723 * Called by a driver the first time it's needed, must be attached to desired
1727 * Zero on success, negative errno on failure.
1729 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1731 if (dev->mode_config.aspect_ratio_property)
1734 dev->mode_config.aspect_ratio_property =
1735 drm_property_create_enum(dev, 0, "aspect ratio",
1736 drm_aspect_ratio_enum_list,
1737 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1739 if (dev->mode_config.aspect_ratio_property == NULL)
1744 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1747 * DOC: standard connector properties
1750 * This property helps select a suitable colorspace based on the sink
1751 * capability. Modern sink devices support wider gamut like BT2020.
1752 * This helps switch to BT2020 mode if the BT2020 encoded video stream
1753 * is being played by the user, same for any other colorspace. Thereby
1754 * giving a good visual experience to users.
1756 * The expectation from userspace is that it should parse the EDID
1757 * and get supported colorspaces. Use this property and switch to the
1758 * one supported. Sink supported colorspaces should be retrieved by
1759 * userspace from EDID and driver will not explicitly expose them.
1761 * Basically the expectation from userspace is:
1762 * - Set up CRTC DEGAMMA/CTM/GAMMA to convert to some sink
1764 * - Set this new property to let the sink know what it
1765 * converted the CRTC output to.
1766 * - This property is just to inform sink what colorspace
1767 * source is trying to drive.
1769 * Because between HDMI and DP have different colorspaces,
1770 * drm_mode_create_hdmi_colorspace_property() is used for HDMI connector and
1771 * drm_mode_create_dp_colorspace_property() is used for DP connector.
1775 * drm_mode_create_hdmi_colorspace_property - create hdmi colorspace property
1776 * @connector: connector to create the Colorspace property on.
1778 * Called by a driver the first time it's needed, must be attached to desired
1782 * Zero on success, negative errono on failure.
1784 int drm_mode_create_hdmi_colorspace_property(struct drm_connector *connector)
1786 struct drm_device *dev = connector->dev;
1788 if (connector->colorspace_property)
1791 connector->colorspace_property =
1792 drm_property_create_enum(dev, DRM_MODE_PROP_ENUM, "Colorspace",
1794 ARRAY_SIZE(hdmi_colorspaces));
1796 if (!connector->colorspace_property)
1801 EXPORT_SYMBOL(drm_mode_create_hdmi_colorspace_property);
1804 * drm_mode_create_dp_colorspace_property - create dp colorspace property
1805 * @connector: connector to create the Colorspace property on.
1807 * Called by a driver the first time it's needed, must be attached to desired
1811 * Zero on success, negative errono on failure.
1813 int drm_mode_create_dp_colorspace_property(struct drm_connector *connector)
1815 struct drm_device *dev = connector->dev;
1817 if (connector->colorspace_property)
1820 connector->colorspace_property =
1821 drm_property_create_enum(dev, DRM_MODE_PROP_ENUM, "Colorspace",
1823 ARRAY_SIZE(dp_colorspaces));
1825 if (!connector->colorspace_property)
1830 EXPORT_SYMBOL(drm_mode_create_dp_colorspace_property);
1833 * drm_mode_create_content_type_property - create content type property
1836 * Called by a driver the first time it's needed, must be attached to desired
1840 * Zero on success, negative errno on failure.
1842 int drm_mode_create_content_type_property(struct drm_device *dev)
1844 if (dev->mode_config.content_type_property)
1847 dev->mode_config.content_type_property =
1848 drm_property_create_enum(dev, 0, "content type",
1849 drm_content_type_enum_list,
1850 ARRAY_SIZE(drm_content_type_enum_list));
1852 if (dev->mode_config.content_type_property == NULL)
1857 EXPORT_SYMBOL(drm_mode_create_content_type_property);
1860 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1863 * Create the the suggested x/y offset property for connectors.
1865 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1867 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1870 dev->mode_config.suggested_x_property =
1871 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1873 dev->mode_config.suggested_y_property =
1874 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1876 if (dev->mode_config.suggested_x_property == NULL ||
1877 dev->mode_config.suggested_y_property == NULL)
1881 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1884 * drm_connector_set_path_property - set tile property on connector
1885 * @connector: connector to set property on.
1886 * @path: path to use for property; must not be NULL.
1888 * This creates a property to expose to userspace to specify a
1889 * connector path. This is mainly used for DisplayPort MST where
1890 * connectors have a topology and we want to allow userspace to give
1891 * them more meaningful names.
1894 * Zero on success, negative errno on failure.
1896 int drm_connector_set_path_property(struct drm_connector *connector,
1899 struct drm_device *dev = connector->dev;
1902 ret = drm_property_replace_global_blob(dev,
1903 &connector->path_blob_ptr,
1907 dev->mode_config.path_property);
1910 EXPORT_SYMBOL(drm_connector_set_path_property);
1913 * drm_connector_set_tile_property - set tile property on connector
1914 * @connector: connector to set property on.
1916 * This looks up the tile information for a connector, and creates a
1917 * property for userspace to parse if it exists. The property is of
1918 * the form of 8 integers using ':' as a separator.
1919 * This is used for dual port tiled displays with DisplayPort SST
1920 * or DisplayPort MST connectors.
1923 * Zero on success, errno on failure.
1925 int drm_connector_set_tile_property(struct drm_connector *connector)
1927 struct drm_device *dev = connector->dev;
1931 if (!connector->has_tile) {
1932 ret = drm_property_replace_global_blob(dev,
1933 &connector->tile_blob_ptr,
1937 dev->mode_config.tile_property);
1941 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
1942 connector->tile_group->id, connector->tile_is_single_monitor,
1943 connector->num_h_tile, connector->num_v_tile,
1944 connector->tile_h_loc, connector->tile_v_loc,
1945 connector->tile_h_size, connector->tile_v_size);
1947 ret = drm_property_replace_global_blob(dev,
1948 &connector->tile_blob_ptr,
1952 dev->mode_config.tile_property);
1955 EXPORT_SYMBOL(drm_connector_set_tile_property);
1958 * drm_connector_update_edid_property - update the edid property of a connector
1959 * @connector: drm connector
1960 * @edid: new value of the edid property
1962 * This function creates a new blob modeset object and assigns its id to the
1963 * connector's edid property.
1964 * Since we also parse tile information from EDID's displayID block, we also
1965 * set the connector's tile property here. See drm_connector_set_tile_property()
1969 * Zero on success, negative errno on failure.
1971 int drm_connector_update_edid_property(struct drm_connector *connector,
1972 const struct edid *edid)
1974 struct drm_device *dev = connector->dev;
1978 /* ignore requests to set edid when overridden */
1979 if (connector->override_edid)
1983 size = EDID_LENGTH * (1 + edid->extensions);
1985 /* Set the display info, using edid if available, otherwise
1986 * reseting the values to defaults. This duplicates the work
1987 * done in drm_add_edid_modes, but that function is not
1988 * consistently called before this one in all drivers and the
1989 * computation is cheap enough that it seems better to
1990 * duplicate it rather than attempt to ensure some arbitrary
1991 * ordering of calls.
1994 drm_add_display_info(connector, edid);
1996 drm_reset_display_info(connector);
1998 drm_update_tile_info(connector, edid);
2000 drm_object_property_set_value(&connector->base,
2001 dev->mode_config.non_desktop_property,
2002 connector->display_info.non_desktop);
2004 ret = drm_property_replace_global_blob(dev,
2005 &connector->edid_blob_ptr,
2009 dev->mode_config.edid_property);
2012 return drm_connector_set_tile_property(connector);
2014 EXPORT_SYMBOL(drm_connector_update_edid_property);
2017 * drm_connector_set_link_status_property - Set link status property of a connector
2018 * @connector: drm connector
2019 * @link_status: new value of link status property (0: Good, 1: Bad)
2021 * In usual working scenario, this link status property will always be set to
2022 * "GOOD". If something fails during or after a mode set, the kernel driver
2023 * may set this link status property to "BAD". The caller then needs to send a
2024 * hotplug uevent for userspace to re-check the valid modes through
2025 * GET_CONNECTOR_IOCTL and retry modeset.
2027 * Note: Drivers cannot rely on userspace to support this property and
2028 * issue a modeset. As such, they may choose to handle issues (like
2029 * re-training a link) without userspace's intervention.
2031 * The reason for adding this property is to handle link training failures, but
2032 * it is not limited to DP or link training. For example, if we implement
2033 * asynchronous setcrtc, this property can be used to report any failures in that.
2035 void drm_connector_set_link_status_property(struct drm_connector *connector,
2036 uint64_t link_status)
2038 struct drm_device *dev = connector->dev;
2040 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2041 connector->state->link_status = link_status;
2042 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2044 EXPORT_SYMBOL(drm_connector_set_link_status_property);
2047 * drm_connector_attach_max_bpc_property - attach "max bpc" property
2048 * @connector: connector to attach max bpc property on.
2049 * @min: The minimum bit depth supported by the connector.
2050 * @max: The maximum bit depth supported by the connector.
2052 * This is used to add support for limiting the bit depth on a connector.
2055 * Zero on success, negative errno on failure.
2057 int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
2060 struct drm_device *dev = connector->dev;
2061 struct drm_property *prop;
2063 prop = connector->max_bpc_property;
2065 prop = drm_property_create_range(dev, 0, "max bpc", min, max);
2069 connector->max_bpc_property = prop;
2072 drm_object_attach_property(&connector->base, prop, max);
2073 connector->state->max_requested_bpc = max;
2074 connector->state->max_bpc = max;
2078 EXPORT_SYMBOL(drm_connector_attach_max_bpc_property);
2081 * drm_connector_set_vrr_capable_property - sets the variable refresh rate
2082 * capable property for a connector
2083 * @connector: drm connector
2084 * @capable: True if the connector is variable refresh rate capable
2086 * Should be used by atomic drivers to update the indicated support for
2087 * variable refresh rate over a connector.
2089 void drm_connector_set_vrr_capable_property(
2090 struct drm_connector *connector, bool capable)
2092 drm_object_property_set_value(&connector->base,
2093 connector->vrr_capable_property,
2096 EXPORT_SYMBOL(drm_connector_set_vrr_capable_property);
2099 * drm_connector_set_panel_orientation - sets the connecter's panel_orientation
2100 * @connector: connector for which to set the panel-orientation property.
2101 * @panel_orientation: drm_panel_orientation value to set
2103 * This function sets the connector's panel_orientation and attaches
2104 * a "panel orientation" property to the connector.
2106 * Calling this function on a connector where the panel_orientation has
2107 * already been set is a no-op (e.g. the orientation has been overridden with
2108 * a kernel commandline option).
2110 * It is allowed to call this function with a panel_orientation of
2111 * DRM_MODE_PANEL_ORIENTATION_UNKNOWN, in which case it is a no-op.
2114 * Zero on success, negative errno on failure.
2116 int drm_connector_set_panel_orientation(
2117 struct drm_connector *connector,
2118 enum drm_panel_orientation panel_orientation)
2120 struct drm_device *dev = connector->dev;
2121 struct drm_display_info *info = &connector->display_info;
2122 struct drm_property *prop;
2125 if (info->panel_orientation != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2128 /* Don't attach the property if the orientation is unknown */
2129 if (panel_orientation == DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2132 info->panel_orientation = panel_orientation;
2134 prop = dev->mode_config.panel_orientation_property;
2136 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
2137 "panel orientation",
2138 drm_panel_orientation_enum_list,
2139 ARRAY_SIZE(drm_panel_orientation_enum_list));
2143 dev->mode_config.panel_orientation_property = prop;
2146 drm_object_attach_property(&connector->base, prop,
2147 info->panel_orientation);
2150 EXPORT_SYMBOL(drm_connector_set_panel_orientation);
2153 * drm_connector_set_panel_orientation_with_quirk -
2154 * set the connecter's panel_orientation after checking for quirks
2155 * @connector: connector for which to init the panel-orientation property.
2156 * @panel_orientation: drm_panel_orientation value to set
2157 * @width: width in pixels of the panel, used for panel quirk detection
2158 * @height: height in pixels of the panel, used for panel quirk detection
2160 * Like drm_connector_set_panel_orientation(), but with a check for platform
2161 * specific (e.g. DMI based) quirks overriding the passed in panel_orientation.
2164 * Zero on success, negative errno on failure.
2166 int drm_connector_set_panel_orientation_with_quirk(
2167 struct drm_connector *connector,
2168 enum drm_panel_orientation panel_orientation,
2169 int width, int height)
2171 int orientation_quirk;
2173 orientation_quirk = drm_get_panel_orientation_quirk(width, height);
2174 if (orientation_quirk != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2175 panel_orientation = orientation_quirk;
2177 return drm_connector_set_panel_orientation(connector,
2180 EXPORT_SYMBOL(drm_connector_set_panel_orientation_with_quirk);
2182 int drm_connector_set_obj_prop(struct drm_mode_object *obj,
2183 struct drm_property *property,
2187 struct drm_connector *connector = obj_to_connector(obj);
2189 /* Do DPMS ourselves */
2190 if (property == connector->dev->mode_config.dpms_property) {
2191 ret = (*connector->funcs->dpms)(connector, (int)value);
2192 } else if (connector->funcs->set_property)
2193 ret = connector->funcs->set_property(connector, property, value);
2196 drm_object_property_set_value(&connector->base, property, value);
2200 int drm_connector_property_set_ioctl(struct drm_device *dev,
2201 void *data, struct drm_file *file_priv)
2203 struct drm_mode_connector_set_property *conn_set_prop = data;
2204 struct drm_mode_obj_set_property obj_set_prop = {
2205 .value = conn_set_prop->value,
2206 .prop_id = conn_set_prop->prop_id,
2207 .obj_id = conn_set_prop->connector_id,
2208 .obj_type = DRM_MODE_OBJECT_CONNECTOR
2211 /* It does all the locking and checking we need */
2212 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
2215 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
2217 /* For atomic drivers only state objects are synchronously updated and
2218 * protected by modeset locks, so check those first. */
2219 if (connector->state)
2220 return connector->state->best_encoder;
2221 return connector->encoder;
2225 drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
2226 const struct list_head *export_list,
2227 const struct drm_file *file_priv)
2230 * If user-space hasn't configured the driver to expose the stereo 3D
2231 * modes, don't expose them.
2233 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
2236 * If user-space hasn't configured the driver to expose the modes
2237 * with aspect-ratio, don't expose them. However if such a mode
2238 * is unique, let it be exposed, but reset the aspect-ratio flags
2239 * while preparing the list of user-modes.
2241 if (!file_priv->aspect_ratio_allowed) {
2242 struct drm_display_mode *mode_itr;
2244 list_for_each_entry(mode_itr, export_list, export_head)
2245 if (drm_mode_match(mode_itr, mode,
2246 DRM_MODE_MATCH_TIMINGS |
2247 DRM_MODE_MATCH_CLOCK |
2248 DRM_MODE_MATCH_FLAGS |
2249 DRM_MODE_MATCH_3D_FLAGS))
2256 int drm_mode_getconnector(struct drm_device *dev, void *data,
2257 struct drm_file *file_priv)
2259 struct drm_mode_get_connector *out_resp = data;
2260 struct drm_connector *connector;
2261 struct drm_encoder *encoder;
2262 struct drm_display_mode *mode;
2264 int encoders_count = 0;
2267 struct drm_mode_modeinfo u_mode;
2268 struct drm_mode_modeinfo __user *mode_ptr;
2269 uint32_t __user *encoder_ptr;
2270 LIST_HEAD(export_list);
2272 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2275 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2277 connector = drm_connector_lookup(dev, file_priv, out_resp->connector_id);
2281 encoders_count = hweight32(connector->possible_encoders);
2283 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2285 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2287 drm_connector_for_each_possible_encoder(connector, encoder) {
2288 if (put_user(encoder->base.id, encoder_ptr + copied)) {
2295 out_resp->count_encoders = encoders_count;
2297 out_resp->connector_id = connector->base.id;
2298 out_resp->connector_type = connector->connector_type;
2299 out_resp->connector_type_id = connector->connector_type_id;
2301 mutex_lock(&dev->mode_config.mutex);
2302 if (out_resp->count_modes == 0) {
2303 connector->funcs->fill_modes(connector,
2304 dev->mode_config.max_width,
2305 dev->mode_config.max_height);
2308 out_resp->mm_width = connector->display_info.width_mm;
2309 out_resp->mm_height = connector->display_info.height_mm;
2310 out_resp->subpixel = connector->display_info.subpixel_order;
2311 out_resp->connection = connector->status;
2313 /* delayed so we get modes regardless of pre-fill_modes state */
2314 list_for_each_entry(mode, &connector->modes, head)
2315 if (drm_mode_expose_to_userspace(mode, &export_list,
2317 list_add_tail(&mode->export_head, &export_list);
2322 * This ioctl is called twice, once to determine how much space is
2323 * needed, and the 2nd time to fill it.
2324 * The modes that need to be exposed to the user are maintained in the
2325 * 'export_list'. When the ioctl is called first time to determine the,
2326 * space, the export_list gets filled, to find the no.of modes. In the
2327 * 2nd time, the user modes are filled, one by one from the export_list.
2329 if ((out_resp->count_modes >= mode_count) && mode_count) {
2331 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2332 list_for_each_entry(mode, &export_list, export_head) {
2333 drm_mode_convert_to_umode(&u_mode, mode);
2335 * Reset aspect ratio flags of user-mode, if modes with
2336 * aspect-ratio are not supported.
2338 if (!file_priv->aspect_ratio_allowed)
2339 u_mode.flags &= ~DRM_MODE_FLAG_PIC_AR_MASK;
2340 if (copy_to_user(mode_ptr + copied,
2341 &u_mode, sizeof(u_mode))) {
2343 mutex_unlock(&dev->mode_config.mutex);
2350 out_resp->count_modes = mode_count;
2351 mutex_unlock(&dev->mode_config.mutex);
2353 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2354 encoder = drm_connector_get_encoder(connector);
2356 out_resp->encoder_id = encoder->base.id;
2358 out_resp->encoder_id = 0;
2360 /* Only grab properties after probing, to make sure EDID and other
2361 * properties reflect the latest status. */
2362 ret = drm_mode_object_get_properties(&connector->base, file_priv->atomic,
2363 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
2364 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
2365 &out_resp->count_props);
2366 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2369 drm_connector_put(connector);
2378 * Tile groups are used to represent tiled monitors with a unique integer
2379 * identifier. Tiled monitors using DisplayID v1.3 have a unique 8-byte handle,
2380 * we store this in a tile group, so we have a common identifier for all tiles
2381 * in a monitor group. The property is called "TILE". Drivers can manage tile
2382 * groups using drm_mode_create_tile_group(), drm_mode_put_tile_group() and
2383 * drm_mode_get_tile_group(). But this is only needed for internal panels where
2384 * the tile group information is exposed through a non-standard way.
2387 static void drm_tile_group_free(struct kref *kref)
2389 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
2390 struct drm_device *dev = tg->dev;
2391 mutex_lock(&dev->mode_config.idr_mutex);
2392 idr_remove(&dev->mode_config.tile_idr, tg->id);
2393 mutex_unlock(&dev->mode_config.idr_mutex);
2398 * drm_mode_put_tile_group - drop a reference to a tile group.
2400 * @tg: tile group to drop reference to.
2402 * drop reference to tile group and free if 0.
2404 void drm_mode_put_tile_group(struct drm_device *dev,
2405 struct drm_tile_group *tg)
2407 kref_put(&tg->refcount, drm_tile_group_free);
2409 EXPORT_SYMBOL(drm_mode_put_tile_group);
2412 * drm_mode_get_tile_group - get a reference to an existing tile group
2414 * @topology: 8-bytes unique per monitor.
2416 * Use the unique bytes to get a reference to an existing tile group.
2419 * tile group or NULL if not found.
2421 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
2422 const char topology[8])
2424 struct drm_tile_group *tg;
2426 mutex_lock(&dev->mode_config.idr_mutex);
2427 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
2428 if (!memcmp(tg->group_data, topology, 8)) {
2429 if (!kref_get_unless_zero(&tg->refcount))
2431 mutex_unlock(&dev->mode_config.idr_mutex);
2435 mutex_unlock(&dev->mode_config.idr_mutex);
2438 EXPORT_SYMBOL(drm_mode_get_tile_group);
2441 * drm_mode_create_tile_group - create a tile group from a displayid description
2443 * @topology: 8-bytes unique per monitor.
2445 * Create a tile group for the unique monitor, and get a unique
2446 * identifier for the tile group.
2449 * new tile group or NULL.
2451 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
2452 const char topology[8])
2454 struct drm_tile_group *tg;
2457 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
2461 kref_init(&tg->refcount);
2462 memcpy(tg->group_data, topology, 8);
2465 mutex_lock(&dev->mode_config.idr_mutex);
2466 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
2474 mutex_unlock(&dev->mode_config.idr_mutex);
2477 EXPORT_SYMBOL(drm_mode_create_tile_group);