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" },
97 void drm_connector_ida_init(void)
101 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
102 ida_init(&drm_connector_enum_list[i].ida);
105 void drm_connector_ida_destroy(void)
109 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
110 ida_destroy(&drm_connector_enum_list[i].ida);
114 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
115 * @connector: connector to quwery
117 * The kernel supports per-connector configuration of its consoles through
118 * use of the video= parameter. This function parses that option and
119 * extracts the user's specified mode (or enable/disable status) for a
120 * particular connector. This is typically only used during the early fbdev
123 static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
125 struct drm_cmdline_mode *mode = &connector->cmdline_mode;
128 if (fb_get_options(connector->name, &option))
131 if (!drm_mode_parse_command_line_for_connector(option,
137 DRM_INFO("forcing %s connector %s\n", connector->name,
138 drm_get_connector_force_name(mode->force));
139 connector->force = mode->force;
142 DRM_DEBUG_KMS("cmdline mode for connector %s %dx%d@%dHz%s%s%s\n",
144 mode->xres, mode->yres,
145 mode->refresh_specified ? mode->refresh : 60,
146 mode->rb ? " reduced blanking" : "",
147 mode->margins ? " with margins" : "",
148 mode->interlace ? " interlaced" : "");
151 static void drm_connector_free(struct kref *kref)
153 struct drm_connector *connector =
154 container_of(kref, struct drm_connector, base.refcount);
155 struct drm_device *dev = connector->dev;
157 drm_mode_object_unregister(dev, &connector->base);
158 connector->funcs->destroy(connector);
161 void drm_connector_free_work_fn(struct work_struct *work)
163 struct drm_connector *connector, *n;
164 struct drm_device *dev =
165 container_of(work, struct drm_device, mode_config.connector_free_work);
166 struct drm_mode_config *config = &dev->mode_config;
168 struct llist_node *freed;
170 spin_lock_irqsave(&config->connector_list_lock, flags);
171 freed = llist_del_all(&config->connector_free_list);
172 spin_unlock_irqrestore(&config->connector_list_lock, flags);
174 llist_for_each_entry_safe(connector, n, freed, free_node) {
175 drm_mode_object_unregister(dev, &connector->base);
176 connector->funcs->destroy(connector);
181 * drm_connector_init - Init a preallocated connector
183 * @connector: the connector to init
184 * @funcs: callbacks for this connector
185 * @connector_type: user visible type of the connector
187 * Initialises a preallocated connector. Connectors should be
188 * subclassed as part of driver connector objects.
191 * Zero on success, error code on failure.
193 int drm_connector_init(struct drm_device *dev,
194 struct drm_connector *connector,
195 const struct drm_connector_funcs *funcs,
198 struct drm_mode_config *config = &dev->mode_config;
200 struct ida *connector_ida =
201 &drm_connector_enum_list[connector_type].ida;
203 WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
204 (!funcs->atomic_destroy_state ||
205 !funcs->atomic_duplicate_state));
207 ret = __drm_mode_object_add(dev, &connector->base,
208 DRM_MODE_OBJECT_CONNECTOR,
209 false, drm_connector_free);
213 connector->base.properties = &connector->properties;
214 connector->dev = dev;
215 connector->funcs = funcs;
217 /* connector index is used with 32bit bitmasks */
218 ret = ida_simple_get(&config->connector_ida, 0, 32, GFP_KERNEL);
220 DRM_DEBUG_KMS("Failed to allocate %s connector index: %d\n",
221 drm_connector_enum_list[connector_type].name,
225 connector->index = ret;
228 connector->connector_type = connector_type;
229 connector->connector_type_id =
230 ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
231 if (connector->connector_type_id < 0) {
232 ret = connector->connector_type_id;
236 kasprintf(GFP_KERNEL, "%s-%d",
237 drm_connector_enum_list[connector_type].name,
238 connector->connector_type_id);
239 if (!connector->name) {
241 goto out_put_type_id;
244 INIT_LIST_HEAD(&connector->probed_modes);
245 INIT_LIST_HEAD(&connector->modes);
246 mutex_init(&connector->mutex);
247 connector->edid_blob_ptr = NULL;
248 connector->status = connector_status_unknown;
249 connector->display_info.panel_orientation =
250 DRM_MODE_PANEL_ORIENTATION_UNKNOWN;
252 drm_connector_get_cmdline_mode(connector);
254 /* We should add connectors at the end to avoid upsetting the connector
256 spin_lock_irq(&config->connector_list_lock);
257 list_add_tail(&connector->head, &config->connector_list);
258 config->num_connector++;
259 spin_unlock_irq(&config->connector_list_lock);
261 if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL &&
262 connector_type != DRM_MODE_CONNECTOR_WRITEBACK)
263 drm_connector_attach_edid_property(connector);
265 drm_object_attach_property(&connector->base,
266 config->dpms_property, 0);
268 drm_object_attach_property(&connector->base,
269 config->link_status_property,
272 drm_object_attach_property(&connector->base,
273 config->non_desktop_property,
276 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
277 drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
280 connector->debugfs_entry = NULL;
283 ida_simple_remove(connector_ida, connector->connector_type_id);
286 ida_simple_remove(&config->connector_ida, connector->index);
289 drm_mode_object_unregister(dev, &connector->base);
293 EXPORT_SYMBOL(drm_connector_init);
296 * drm_connector_attach_edid_property - attach edid property.
297 * @connector: the connector
299 * Some connector types like DRM_MODE_CONNECTOR_VIRTUAL do not get a
300 * edid property attached by default. This function can be used to
301 * explicitly enable the edid property in these cases.
303 void drm_connector_attach_edid_property(struct drm_connector *connector)
305 struct drm_mode_config *config = &connector->dev->mode_config;
307 drm_object_attach_property(&connector->base,
308 config->edid_property,
311 EXPORT_SYMBOL(drm_connector_attach_edid_property);
314 * drm_connector_attach_encoder - attach a connector to an encoder
315 * @connector: connector to attach
316 * @encoder: encoder to attach @connector to
318 * This function links up a connector to an encoder. Note that the routing
319 * restrictions between encoders and crtcs are exposed to userspace through the
320 * possible_clones and possible_crtcs bitmasks.
323 * Zero on success, negative errno on failure.
325 int drm_connector_attach_encoder(struct drm_connector *connector,
326 struct drm_encoder *encoder)
331 * In the past, drivers have attempted to model the static association
332 * of connector to encoder in simple connector/encoder devices using a
333 * direct assignment of connector->encoder = encoder. This connection
334 * is a logical one and the responsibility of the core, so drivers are
335 * expected not to mess with this.
337 * Note that the error return should've been enough here, but a large
338 * majority of drivers ignores the return value, so add in a big WARN
339 * to get people's attention.
341 if (WARN_ON(connector->encoder))
344 for (i = 0; i < ARRAY_SIZE(connector->encoder_ids); i++) {
345 if (connector->encoder_ids[i] == 0) {
346 connector->encoder_ids[i] = encoder->base.id;
352 EXPORT_SYMBOL(drm_connector_attach_encoder);
355 * drm_connector_has_possible_encoder - check if the connector and encoder are assosicated with each other
356 * @connector: the connector
357 * @encoder: the encoder
360 * True if @encoder is one of the possible encoders for @connector.
362 bool drm_connector_has_possible_encoder(struct drm_connector *connector,
363 struct drm_encoder *encoder)
365 struct drm_encoder *enc;
368 drm_connector_for_each_possible_encoder(connector, enc, i) {
375 EXPORT_SYMBOL(drm_connector_has_possible_encoder);
377 static void drm_mode_remove(struct drm_connector *connector,
378 struct drm_display_mode *mode)
380 list_del(&mode->head);
381 drm_mode_destroy(connector->dev, mode);
385 * drm_connector_cleanup - cleans up an initialised connector
386 * @connector: connector to cleanup
388 * Cleans up the connector but doesn't free the object.
390 void drm_connector_cleanup(struct drm_connector *connector)
392 struct drm_device *dev = connector->dev;
393 struct drm_display_mode *mode, *t;
395 /* The connector should have been removed from userspace long before
396 * it is finally destroyed.
398 if (WARN_ON(connector->registration_state ==
399 DRM_CONNECTOR_REGISTERED))
400 drm_connector_unregister(connector);
402 if (connector->tile_group) {
403 drm_mode_put_tile_group(dev, connector->tile_group);
404 connector->tile_group = NULL;
407 list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
408 drm_mode_remove(connector, mode);
410 list_for_each_entry_safe(mode, t, &connector->modes, head)
411 drm_mode_remove(connector, mode);
413 ida_simple_remove(&drm_connector_enum_list[connector->connector_type].ida,
414 connector->connector_type_id);
416 ida_simple_remove(&dev->mode_config.connector_ida,
419 kfree(connector->display_info.bus_formats);
420 drm_mode_object_unregister(dev, &connector->base);
421 kfree(connector->name);
422 connector->name = NULL;
423 spin_lock_irq(&dev->mode_config.connector_list_lock);
424 list_del(&connector->head);
425 dev->mode_config.num_connector--;
426 spin_unlock_irq(&dev->mode_config.connector_list_lock);
428 WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
429 if (connector->state && connector->funcs->atomic_destroy_state)
430 connector->funcs->atomic_destroy_state(connector,
433 mutex_destroy(&connector->mutex);
435 memset(connector, 0, sizeof(*connector));
437 EXPORT_SYMBOL(drm_connector_cleanup);
440 * drm_connector_register - register a connector
441 * @connector: the connector to register
443 * Register userspace interfaces for a connector
446 * Zero on success, error code on failure.
448 int drm_connector_register(struct drm_connector *connector)
452 if (!connector->dev->registered)
455 mutex_lock(&connector->mutex);
456 if (connector->registration_state != DRM_CONNECTOR_INITIALIZING)
459 ret = drm_sysfs_connector_add(connector);
463 ret = drm_debugfs_connector_add(connector);
468 if (connector->funcs->late_register) {
469 ret = connector->funcs->late_register(connector);
474 drm_mode_object_register(connector->dev, &connector->base);
476 connector->registration_state = DRM_CONNECTOR_REGISTERED;
480 drm_debugfs_connector_remove(connector);
482 drm_sysfs_connector_remove(connector);
484 mutex_unlock(&connector->mutex);
487 EXPORT_SYMBOL(drm_connector_register);
490 * drm_connector_unregister - unregister a connector
491 * @connector: the connector to unregister
493 * Unregister userspace interfaces for a connector
495 void drm_connector_unregister(struct drm_connector *connector)
497 mutex_lock(&connector->mutex);
498 if (connector->registration_state != DRM_CONNECTOR_REGISTERED) {
499 mutex_unlock(&connector->mutex);
503 if (connector->funcs->early_unregister)
504 connector->funcs->early_unregister(connector);
506 drm_sysfs_connector_remove(connector);
507 drm_debugfs_connector_remove(connector);
509 connector->registration_state = DRM_CONNECTOR_UNREGISTERED;
510 mutex_unlock(&connector->mutex);
512 EXPORT_SYMBOL(drm_connector_unregister);
514 void drm_connector_unregister_all(struct drm_device *dev)
516 struct drm_connector *connector;
517 struct drm_connector_list_iter conn_iter;
519 drm_connector_list_iter_begin(dev, &conn_iter);
520 drm_for_each_connector_iter(connector, &conn_iter)
521 drm_connector_unregister(connector);
522 drm_connector_list_iter_end(&conn_iter);
525 int drm_connector_register_all(struct drm_device *dev)
527 struct drm_connector *connector;
528 struct drm_connector_list_iter conn_iter;
531 drm_connector_list_iter_begin(dev, &conn_iter);
532 drm_for_each_connector_iter(connector, &conn_iter) {
533 ret = drm_connector_register(connector);
537 drm_connector_list_iter_end(&conn_iter);
540 drm_connector_unregister_all(dev);
545 * drm_get_connector_status_name - return a string for connector status
546 * @status: connector status to compute name of
548 * In contrast to the other drm_get_*_name functions this one here returns a
549 * const pointer and hence is threadsafe.
551 const char *drm_get_connector_status_name(enum drm_connector_status status)
553 if (status == connector_status_connected)
555 else if (status == connector_status_disconnected)
556 return "disconnected";
560 EXPORT_SYMBOL(drm_get_connector_status_name);
563 * drm_get_connector_force_name - return a string for connector force
564 * @force: connector force to get name of
566 * Returns: const pointer to name.
568 const char *drm_get_connector_force_name(enum drm_connector_force force)
571 case DRM_FORCE_UNSPECIFIED:
572 return "unspecified";
577 case DRM_FORCE_ON_DIGITAL:
584 #ifdef CONFIG_LOCKDEP
585 static struct lockdep_map connector_list_iter_dep_map = {
586 .name = "drm_connector_list_iter"
591 * drm_connector_list_iter_begin - initialize a connector_list iterator
593 * @iter: connector_list iterator
595 * Sets @iter up to walk the &drm_mode_config.connector_list of @dev. @iter
596 * must always be cleaned up again by calling drm_connector_list_iter_end().
597 * Iteration itself happens using drm_connector_list_iter_next() or
598 * drm_for_each_connector_iter().
600 void drm_connector_list_iter_begin(struct drm_device *dev,
601 struct drm_connector_list_iter *iter)
605 lock_acquire_shared_recursive(&connector_list_iter_dep_map, 0, 1, NULL, _RET_IP_);
607 EXPORT_SYMBOL(drm_connector_list_iter_begin);
610 * Extra-safe connector put function that works in any context. Should only be
611 * used from the connector_iter functions, where we never really expect to
612 * actually release the connector when dropping our final reference.
615 __drm_connector_put_safe(struct drm_connector *conn)
617 struct drm_mode_config *config = &conn->dev->mode_config;
619 lockdep_assert_held(&config->connector_list_lock);
621 if (!refcount_dec_and_test(&conn->base.refcount.refcount))
624 llist_add(&conn->free_node, &config->connector_free_list);
625 schedule_work(&config->connector_free_work);
629 * drm_connector_list_iter_next - return next connector
630 * @iter: connector_list iterator
632 * Returns the next connector for @iter, or NULL when the list walk has
635 struct drm_connector *
636 drm_connector_list_iter_next(struct drm_connector_list_iter *iter)
638 struct drm_connector *old_conn = iter->conn;
639 struct drm_mode_config *config = &iter->dev->mode_config;
640 struct list_head *lhead;
643 spin_lock_irqsave(&config->connector_list_lock, flags);
644 lhead = old_conn ? &old_conn->head : &config->connector_list;
647 if (lhead->next == &config->connector_list) {
653 iter->conn = list_entry(lhead, struct drm_connector, head);
655 /* loop until it's not a zombie connector */
656 } while (!kref_get_unless_zero(&iter->conn->base.refcount));
659 __drm_connector_put_safe(old_conn);
660 spin_unlock_irqrestore(&config->connector_list_lock, flags);
664 EXPORT_SYMBOL(drm_connector_list_iter_next);
667 * drm_connector_list_iter_end - tear down a connector_list iterator
668 * @iter: connector_list iterator
670 * Tears down @iter and releases any resources (like &drm_connector references)
671 * acquired while walking the list. This must always be called, both when the
672 * iteration completes fully or when it was aborted without walking the entire
675 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter)
677 struct drm_mode_config *config = &iter->dev->mode_config;
682 spin_lock_irqsave(&config->connector_list_lock, flags);
683 __drm_connector_put_safe(iter->conn);
684 spin_unlock_irqrestore(&config->connector_list_lock, flags);
686 lock_release(&connector_list_iter_dep_map, 0, _RET_IP_);
688 EXPORT_SYMBOL(drm_connector_list_iter_end);
690 static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
691 { SubPixelUnknown, "Unknown" },
692 { SubPixelHorizontalRGB, "Horizontal RGB" },
693 { SubPixelHorizontalBGR, "Horizontal BGR" },
694 { SubPixelVerticalRGB, "Vertical RGB" },
695 { SubPixelVerticalBGR, "Vertical BGR" },
696 { SubPixelNone, "None" },
700 * drm_get_subpixel_order_name - return a string for a given subpixel enum
701 * @order: enum of subpixel_order
703 * Note you could abuse this and return something out of bounds, but that
704 * would be a caller error. No unscrubbed user data should make it here.
706 const char *drm_get_subpixel_order_name(enum subpixel_order order)
708 return drm_subpixel_enum_list[order].name;
710 EXPORT_SYMBOL(drm_get_subpixel_order_name);
712 static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
713 { DRM_MODE_DPMS_ON, "On" },
714 { DRM_MODE_DPMS_STANDBY, "Standby" },
715 { DRM_MODE_DPMS_SUSPEND, "Suspend" },
716 { DRM_MODE_DPMS_OFF, "Off" }
718 DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
720 static const struct drm_prop_enum_list drm_link_status_enum_list[] = {
721 { DRM_MODE_LINK_STATUS_GOOD, "Good" },
722 { DRM_MODE_LINK_STATUS_BAD, "Bad" },
726 * drm_display_info_set_bus_formats - set the supported bus formats
727 * @info: display info to store bus formats in
728 * @formats: array containing the supported bus formats
729 * @num_formats: the number of entries in the fmts array
731 * Store the supported bus formats in display info structure.
732 * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
733 * a full list of available formats.
735 int drm_display_info_set_bus_formats(struct drm_display_info *info,
737 unsigned int num_formats)
741 if (!formats && num_formats)
744 if (formats && num_formats) {
745 fmts = kmemdup(formats, sizeof(*formats) * num_formats,
751 kfree(info->bus_formats);
752 info->bus_formats = fmts;
753 info->num_bus_formats = num_formats;
757 EXPORT_SYMBOL(drm_display_info_set_bus_formats);
759 /* Optional connector properties. */
760 static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
761 { DRM_MODE_SCALE_NONE, "None" },
762 { DRM_MODE_SCALE_FULLSCREEN, "Full" },
763 { DRM_MODE_SCALE_CENTER, "Center" },
764 { DRM_MODE_SCALE_ASPECT, "Full aspect" },
767 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
768 { DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
769 { DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
770 { DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
773 static const struct drm_prop_enum_list drm_content_type_enum_list[] = {
774 { DRM_MODE_CONTENT_TYPE_NO_DATA, "No Data" },
775 { DRM_MODE_CONTENT_TYPE_GRAPHICS, "Graphics" },
776 { DRM_MODE_CONTENT_TYPE_PHOTO, "Photo" },
777 { DRM_MODE_CONTENT_TYPE_CINEMA, "Cinema" },
778 { DRM_MODE_CONTENT_TYPE_GAME, "Game" },
781 static const struct drm_prop_enum_list drm_panel_orientation_enum_list[] = {
782 { DRM_MODE_PANEL_ORIENTATION_NORMAL, "Normal" },
783 { DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP, "Upside Down" },
784 { DRM_MODE_PANEL_ORIENTATION_LEFT_UP, "Left Side Up" },
785 { DRM_MODE_PANEL_ORIENTATION_RIGHT_UP, "Right Side Up" },
788 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
789 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
790 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
791 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
793 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
795 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
796 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
797 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
798 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
800 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
801 drm_dvi_i_subconnector_enum_list)
803 static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
804 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
805 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
806 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
807 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
808 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
810 DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
812 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
813 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
814 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
815 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
816 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
817 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
819 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
820 drm_tv_subconnector_enum_list)
822 static struct drm_prop_enum_list drm_cp_enum_list[] = {
823 { DRM_MODE_CONTENT_PROTECTION_UNDESIRED, "Undesired" },
824 { DRM_MODE_CONTENT_PROTECTION_DESIRED, "Desired" },
825 { DRM_MODE_CONTENT_PROTECTION_ENABLED, "Enabled" },
827 DRM_ENUM_NAME_FN(drm_get_content_protection_name, drm_cp_enum_list)
830 * DOC: standard connector properties
832 * DRM connectors have a few standardized properties:
835 * Blob property which contains the current EDID read from the sink. This
836 * is useful to parse sink identification information like vendor, model
837 * and serial. Drivers should update this property by calling
838 * drm_connector_update_edid_property(), usually after having parsed
839 * the EDID using drm_add_edid_modes(). Userspace cannot change this
842 * Legacy property for setting the power state of the connector. For atomic
843 * drivers this is only provided for backwards compatibility with existing
844 * drivers, it remaps to controlling the "ACTIVE" property on the CRTC the
845 * connector is linked to. Drivers should never set this property directly,
846 * it is handled by the DRM core by calling the &drm_connector_funcs.dpms
847 * callback. For atomic drivers the remapping to the "ACTIVE" property is
848 * implemented in the DRM core. This is the only standard connector
849 * property that userspace can change.
851 * Note that this property cannot be set through the MODE_ATOMIC ioctl,
852 * userspace must use "ACTIVE" on the CRTC instead.
856 * For userspace also running on legacy drivers the "DPMS" semantics are a
857 * lot more complicated. First, userspace cannot rely on the "DPMS" value
858 * returned by the GETCONNECTOR actually reflecting reality, because many
859 * drivers fail to update it. For atomic drivers this is taken care of in
860 * drm_atomic_helper_update_legacy_modeset_state().
862 * The second issue is that the DPMS state is only well-defined when the
863 * connector is connected to a CRTC. In atomic the DRM core enforces that
864 * "ACTIVE" is off in such a case, no such checks exists for "DPMS".
866 * Finally, when enabling an output using the legacy SETCONFIG ioctl then
867 * "DPMS" is forced to ON. But see above, that might not be reflected in
868 * the software value on legacy drivers.
870 * Summarizing: Only set "DPMS" when the connector is known to be enabled,
871 * assume that a successful SETCONFIG call also sets "DPMS" to on, and
872 * never read back the value of "DPMS" because it can be incorrect.
874 * Connector path property to identify how this sink is physically
875 * connected. Used by DP MST. This should be set by calling
876 * drm_connector_set_path_property(), in the case of DP MST with the
877 * path property the MST manager created. Userspace cannot change this
880 * Connector tile group property to indicate how a set of DRM connector
881 * compose together into one logical screen. This is used by both high-res
882 * external screens (often only using a single cable, but exposing multiple
883 * DP MST sinks), or high-res integrated panels (like dual-link DSI) which
884 * are not gen-locked. Note that for tiled panels which are genlocked, like
885 * dual-link LVDS or dual-link DSI, the driver should try to not expose the
886 * tiling and virtualize both &drm_crtc and &drm_plane if needed. Drivers
887 * should update this value using drm_connector_set_tile_property().
888 * Userspace cannot change this property.
890 * Connector link-status property to indicate the status of link. The
891 * default value of link-status is "GOOD". If something fails during or
892 * after modeset, the kernel driver may set this to "BAD" and issue a
893 * hotplug uevent. Drivers should update this value using
894 * drm_connector_set_link_status_property().
896 * Indicates the output should be ignored for purposes of displaying a
897 * standard desktop environment or console. This is most likely because
898 * the output device is not rectilinear.
899 * Content Protection:
900 * This property is used by userspace to request the kernel protect future
901 * content communicated over the link. When requested, kernel will apply
902 * the appropriate means of protection (most often HDCP), and use the
903 * property to tell userspace the protection is active.
905 * Drivers can set this up by calling
906 * drm_connector_attach_content_protection_property() on initialization.
908 * The value of this property can be one of the following:
910 * DRM_MODE_CONTENT_PROTECTION_UNDESIRED = 0
911 * The link is not protected, content is transmitted in the clear.
912 * DRM_MODE_CONTENT_PROTECTION_DESIRED = 1
913 * Userspace has requested content protection, but the link is not
914 * currently protected. When in this state, kernel should enable
915 * Content Protection as soon as possible.
916 * DRM_MODE_CONTENT_PROTECTION_ENABLED = 2
917 * Userspace has requested content protection, and the link is
918 * protected. Only the driver can set the property to this value.
919 * If userspace attempts to set to ENABLED, kernel will return
924 * - DESIRED state should be preserved until userspace de-asserts it by
925 * setting the property to UNDESIRED. This means ENABLED should only
926 * transition to UNDESIRED when the user explicitly requests it.
927 * - If the state is DESIRED, kernel should attempt to re-authenticate the
928 * link whenever possible. This includes across disable/enable, dpms,
929 * hotplug, downstream device changes, link status failures, etc..
930 * - Userspace is responsible for polling the property to determine when
931 * the value transitions from ENABLED to DESIRED. This signifies the link
932 * is no longer protected and userspace should take appropriate action
933 * (whatever that might be).
936 * This range property is used by userspace to limit the bit depth. When
937 * used the driver would limit the bpc in accordance with the valid range
938 * supported by the hardware and sink. Drivers to use the function
939 * drm_connector_attach_max_bpc_property() to create and attach the
940 * property to the connector during initialization.
942 * Connectors also have one standardized atomic property:
945 * Mode object ID of the &drm_crtc this connector should be connected to.
947 * Connectors for LCD panels may also have one standardized property:
950 * On some devices the LCD panel is mounted in the casing in such a way
951 * that the up/top side of the panel does not match with the top side of
952 * the device. Userspace can use this property to check for this.
953 * Note that input coordinates from touchscreens (input devices with
954 * INPUT_PROP_DIRECT) will still map 1:1 to the actual LCD panel
955 * coordinates, so if userspace rotates the picture to adjust for
956 * the orientation it must also apply the same transformation to the
957 * touchscreen input coordinates. This property is initialized by calling
958 * drm_connector_init_panel_orientation_property().
961 * This property defines how a non-native mode is upscaled to the native
962 * mode of an LCD panel:
965 * No upscaling happens, scaling is left to the panel. Not all
966 * drivers expose this mode.
968 * The output is upscaled to the full resolution of the panel,
969 * ignoring the aspect ratio.
971 * No upscaling happens, the output is centered within the native
972 * resolution the panel.
974 * The output is upscaled to maximize either the width or height
975 * while retaining the aspect ratio.
977 * This property should be set up by calling
978 * drm_connector_attach_scaling_mode_property(). Note that drivers
979 * can also expose this property to external outputs, in which case they
980 * must support "None", which should be the default (since external screens
981 * have a built-in scaler).
984 int drm_connector_create_standard_properties(struct drm_device *dev)
986 struct drm_property *prop;
988 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
989 DRM_MODE_PROP_IMMUTABLE,
993 dev->mode_config.edid_property = prop;
995 prop = drm_property_create_enum(dev, 0,
996 "DPMS", drm_dpms_enum_list,
997 ARRAY_SIZE(drm_dpms_enum_list));
1000 dev->mode_config.dpms_property = prop;
1002 prop = drm_property_create(dev,
1003 DRM_MODE_PROP_BLOB |
1004 DRM_MODE_PROP_IMMUTABLE,
1008 dev->mode_config.path_property = prop;
1010 prop = drm_property_create(dev,
1011 DRM_MODE_PROP_BLOB |
1012 DRM_MODE_PROP_IMMUTABLE,
1016 dev->mode_config.tile_property = prop;
1018 prop = drm_property_create_enum(dev, 0, "link-status",
1019 drm_link_status_enum_list,
1020 ARRAY_SIZE(drm_link_status_enum_list));
1023 dev->mode_config.link_status_property = prop;
1025 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE, "non-desktop");
1028 dev->mode_config.non_desktop_property = prop;
1034 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1037 * Called by a driver the first time a DVI-I connector is made.
1039 int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1041 struct drm_property *dvi_i_selector;
1042 struct drm_property *dvi_i_subconnector;
1044 if (dev->mode_config.dvi_i_select_subconnector_property)
1048 drm_property_create_enum(dev, 0,
1049 "select subconnector",
1050 drm_dvi_i_select_enum_list,
1051 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1052 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1054 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1056 drm_dvi_i_subconnector_enum_list,
1057 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1058 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1062 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1065 * DOC: HDMI connector properties
1067 * content type (HDMI specific):
1068 * Indicates content type setting to be used in HDMI infoframes to indicate
1069 * content type for the external device, so that it adjusts it's display
1070 * settings accordingly.
1072 * The value of this property can be one of the following:
1075 * Content type is unknown
1077 * Content type is graphics
1079 * Content type is photo
1081 * Content type is cinema
1083 * Content type is game
1085 * Drivers can set up this property by calling
1086 * drm_connector_attach_content_type_property(). Decoding to
1087 * infoframe values is done through drm_hdmi_avi_infoframe_content_type().
1091 * drm_connector_attach_content_type_property - attach content-type property
1092 * @connector: connector to attach content type property on.
1094 * Called by a driver the first time a HDMI connector is made.
1096 int drm_connector_attach_content_type_property(struct drm_connector *connector)
1098 if (!drm_mode_create_content_type_property(connector->dev))
1099 drm_object_attach_property(&connector->base,
1100 connector->dev->mode_config.content_type_property,
1101 DRM_MODE_CONTENT_TYPE_NO_DATA);
1104 EXPORT_SYMBOL(drm_connector_attach_content_type_property);
1108 * drm_hdmi_avi_infoframe_content_type() - fill the HDMI AVI infoframe
1109 * content type information, based
1110 * on correspondent DRM property.
1111 * @frame: HDMI AVI infoframe
1112 * @conn_state: DRM display connector state
1115 void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
1116 const struct drm_connector_state *conn_state)
1118 switch (conn_state->content_type) {
1119 case DRM_MODE_CONTENT_TYPE_GRAPHICS:
1120 frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1122 case DRM_MODE_CONTENT_TYPE_CINEMA:
1123 frame->content_type = HDMI_CONTENT_TYPE_CINEMA;
1125 case DRM_MODE_CONTENT_TYPE_GAME:
1126 frame->content_type = HDMI_CONTENT_TYPE_GAME;
1128 case DRM_MODE_CONTENT_TYPE_PHOTO:
1129 frame->content_type = HDMI_CONTENT_TYPE_PHOTO;
1132 /* Graphics is the default(0) */
1133 frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1136 frame->itc = conn_state->content_type != DRM_MODE_CONTENT_TYPE_NO_DATA;
1138 EXPORT_SYMBOL(drm_hdmi_avi_infoframe_content_type);
1141 * drm_create_tv_properties - create TV specific connector properties
1143 * @num_modes: number of different TV formats (modes) supported
1144 * @modes: array of pointers to strings containing name of each format
1146 * Called by a driver's TV initialization routine, this function creates
1147 * the TV specific connector properties for a given device. Caller is
1148 * responsible for allocating a list of format names and passing them to
1151 int drm_mode_create_tv_properties(struct drm_device *dev,
1152 unsigned int num_modes,
1153 const char * const modes[])
1155 struct drm_property *tv_selector;
1156 struct drm_property *tv_subconnector;
1159 if (dev->mode_config.tv_select_subconnector_property)
1163 * Basic connector properties
1165 tv_selector = drm_property_create_enum(dev, 0,
1166 "select subconnector",
1167 drm_tv_select_enum_list,
1168 ARRAY_SIZE(drm_tv_select_enum_list));
1172 dev->mode_config.tv_select_subconnector_property = tv_selector;
1175 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1177 drm_tv_subconnector_enum_list,
1178 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1179 if (!tv_subconnector)
1181 dev->mode_config.tv_subconnector_property = tv_subconnector;
1184 * Other, TV specific properties: margins & TV modes.
1186 dev->mode_config.tv_left_margin_property =
1187 drm_property_create_range(dev, 0, "left margin", 0, 100);
1188 if (!dev->mode_config.tv_left_margin_property)
1191 dev->mode_config.tv_right_margin_property =
1192 drm_property_create_range(dev, 0, "right margin", 0, 100);
1193 if (!dev->mode_config.tv_right_margin_property)
1196 dev->mode_config.tv_top_margin_property =
1197 drm_property_create_range(dev, 0, "top margin", 0, 100);
1198 if (!dev->mode_config.tv_top_margin_property)
1201 dev->mode_config.tv_bottom_margin_property =
1202 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1203 if (!dev->mode_config.tv_bottom_margin_property)
1206 dev->mode_config.tv_mode_property =
1207 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1209 if (!dev->mode_config.tv_mode_property)
1212 for (i = 0; i < num_modes; i++)
1213 drm_property_add_enum(dev->mode_config.tv_mode_property,
1216 dev->mode_config.tv_brightness_property =
1217 drm_property_create_range(dev, 0, "brightness", 0, 100);
1218 if (!dev->mode_config.tv_brightness_property)
1221 dev->mode_config.tv_contrast_property =
1222 drm_property_create_range(dev, 0, "contrast", 0, 100);
1223 if (!dev->mode_config.tv_contrast_property)
1226 dev->mode_config.tv_flicker_reduction_property =
1227 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1228 if (!dev->mode_config.tv_flicker_reduction_property)
1231 dev->mode_config.tv_overscan_property =
1232 drm_property_create_range(dev, 0, "overscan", 0, 100);
1233 if (!dev->mode_config.tv_overscan_property)
1236 dev->mode_config.tv_saturation_property =
1237 drm_property_create_range(dev, 0, "saturation", 0, 100);
1238 if (!dev->mode_config.tv_saturation_property)
1241 dev->mode_config.tv_hue_property =
1242 drm_property_create_range(dev, 0, "hue", 0, 100);
1243 if (!dev->mode_config.tv_hue_property)
1250 EXPORT_SYMBOL(drm_mode_create_tv_properties);
1253 * drm_mode_create_scaling_mode_property - create scaling mode property
1256 * Called by a driver the first time it's needed, must be attached to desired
1259 * Atomic drivers should use drm_connector_attach_scaling_mode_property()
1260 * instead to correctly assign &drm_connector_state.picture_aspect_ratio
1261 * in the atomic state.
1263 int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1265 struct drm_property *scaling_mode;
1267 if (dev->mode_config.scaling_mode_property)
1271 drm_property_create_enum(dev, 0, "scaling mode",
1272 drm_scaling_mode_enum_list,
1273 ARRAY_SIZE(drm_scaling_mode_enum_list));
1275 dev->mode_config.scaling_mode_property = scaling_mode;
1279 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1282 * drm_connector_attach_scaling_mode_property - attach atomic scaling mode property
1283 * @connector: connector to attach scaling mode property on.
1284 * @scaling_mode_mask: or'ed mask of BIT(%DRM_MODE_SCALE_\*).
1286 * This is used to add support for scaling mode to atomic drivers.
1287 * The scaling mode will be set to &drm_connector_state.picture_aspect_ratio
1288 * and can be used from &drm_connector_helper_funcs->atomic_check for validation.
1290 * This is the atomic version of drm_mode_create_scaling_mode_property().
1293 * Zero on success, negative errno on failure.
1295 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1296 u32 scaling_mode_mask)
1298 struct drm_device *dev = connector->dev;
1299 struct drm_property *scaling_mode_property;
1301 const unsigned valid_scaling_mode_mask =
1302 (1U << ARRAY_SIZE(drm_scaling_mode_enum_list)) - 1;
1304 if (WARN_ON(hweight32(scaling_mode_mask) < 2 ||
1305 scaling_mode_mask & ~valid_scaling_mode_mask))
1308 scaling_mode_property =
1309 drm_property_create(dev, DRM_MODE_PROP_ENUM, "scaling mode",
1310 hweight32(scaling_mode_mask));
1312 if (!scaling_mode_property)
1315 for (i = 0; i < ARRAY_SIZE(drm_scaling_mode_enum_list); i++) {
1318 if (!(BIT(i) & scaling_mode_mask))
1321 ret = drm_property_add_enum(scaling_mode_property,
1322 drm_scaling_mode_enum_list[i].type,
1323 drm_scaling_mode_enum_list[i].name);
1326 drm_property_destroy(dev, scaling_mode_property);
1332 drm_object_attach_property(&connector->base,
1333 scaling_mode_property, 0);
1335 connector->scaling_mode_property = scaling_mode_property;
1339 EXPORT_SYMBOL(drm_connector_attach_scaling_mode_property);
1342 * drm_connector_attach_content_protection_property - attach content protection
1345 * @connector: connector to attach CP property on.
1347 * This is used to add support for content protection on select connectors.
1348 * Content Protection is intentionally vague to allow for different underlying
1349 * technologies, however it is most implemented by HDCP.
1351 * The content protection will be set to &drm_connector_state.content_protection
1354 * Zero on success, negative errno on failure.
1356 int drm_connector_attach_content_protection_property(
1357 struct drm_connector *connector)
1359 struct drm_device *dev = connector->dev;
1360 struct drm_property *prop;
1362 prop = drm_property_create_enum(dev, 0, "Content Protection",
1364 ARRAY_SIZE(drm_cp_enum_list));
1368 drm_object_attach_property(&connector->base, prop,
1369 DRM_MODE_CONTENT_PROTECTION_UNDESIRED);
1371 connector->content_protection_property = prop;
1375 EXPORT_SYMBOL(drm_connector_attach_content_protection_property);
1378 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1381 * Called by a driver the first time it's needed, must be attached to desired
1385 * Zero on success, negative errno on failure.
1387 int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1389 if (dev->mode_config.aspect_ratio_property)
1392 dev->mode_config.aspect_ratio_property =
1393 drm_property_create_enum(dev, 0, "aspect ratio",
1394 drm_aspect_ratio_enum_list,
1395 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1397 if (dev->mode_config.aspect_ratio_property == NULL)
1402 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1405 * drm_mode_create_content_type_property - create content type property
1408 * Called by a driver the first time it's needed, must be attached to desired
1412 * Zero on success, negative errno on failure.
1414 int drm_mode_create_content_type_property(struct drm_device *dev)
1416 if (dev->mode_config.content_type_property)
1419 dev->mode_config.content_type_property =
1420 drm_property_create_enum(dev, 0, "content type",
1421 drm_content_type_enum_list,
1422 ARRAY_SIZE(drm_content_type_enum_list));
1424 if (dev->mode_config.content_type_property == NULL)
1429 EXPORT_SYMBOL(drm_mode_create_content_type_property);
1432 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1435 * Create the the suggested x/y offset property for connectors.
1437 int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1439 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1442 dev->mode_config.suggested_x_property =
1443 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1445 dev->mode_config.suggested_y_property =
1446 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1448 if (dev->mode_config.suggested_x_property == NULL ||
1449 dev->mode_config.suggested_y_property == NULL)
1453 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1456 * drm_connector_set_path_property - set tile property on connector
1457 * @connector: connector to set property on.
1458 * @path: path to use for property; must not be NULL.
1460 * This creates a property to expose to userspace to specify a
1461 * connector path. This is mainly used for DisplayPort MST where
1462 * connectors have a topology and we want to allow userspace to give
1463 * them more meaningful names.
1466 * Zero on success, negative errno on failure.
1468 int drm_connector_set_path_property(struct drm_connector *connector,
1471 struct drm_device *dev = connector->dev;
1474 ret = drm_property_replace_global_blob(dev,
1475 &connector->path_blob_ptr,
1479 dev->mode_config.path_property);
1482 EXPORT_SYMBOL(drm_connector_set_path_property);
1485 * drm_connector_set_tile_property - set tile property on connector
1486 * @connector: connector to set property on.
1488 * This looks up the tile information for a connector, and creates a
1489 * property for userspace to parse if it exists. The property is of
1490 * the form of 8 integers using ':' as a separator.
1493 * Zero on success, errno on failure.
1495 int drm_connector_set_tile_property(struct drm_connector *connector)
1497 struct drm_device *dev = connector->dev;
1501 if (!connector->has_tile) {
1502 ret = drm_property_replace_global_blob(dev,
1503 &connector->tile_blob_ptr,
1507 dev->mode_config.tile_property);
1511 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
1512 connector->tile_group->id, connector->tile_is_single_monitor,
1513 connector->num_h_tile, connector->num_v_tile,
1514 connector->tile_h_loc, connector->tile_v_loc,
1515 connector->tile_h_size, connector->tile_v_size);
1517 ret = drm_property_replace_global_blob(dev,
1518 &connector->tile_blob_ptr,
1522 dev->mode_config.tile_property);
1525 EXPORT_SYMBOL(drm_connector_set_tile_property);
1528 * drm_connector_update_edid_property - update the edid property of a connector
1529 * @connector: drm connector
1530 * @edid: new value of the edid property
1532 * This function creates a new blob modeset object and assigns its id to the
1533 * connector's edid property.
1536 * Zero on success, negative errno on failure.
1538 int drm_connector_update_edid_property(struct drm_connector *connector,
1539 const struct edid *edid)
1541 struct drm_device *dev = connector->dev;
1545 /* ignore requests to set edid when overridden */
1546 if (connector->override_edid)
1550 size = EDID_LENGTH * (1 + edid->extensions);
1552 /* Set the display info, using edid if available, otherwise
1553 * reseting the values to defaults. This duplicates the work
1554 * done in drm_add_edid_modes, but that function is not
1555 * consistently called before this one in all drivers and the
1556 * computation is cheap enough that it seems better to
1557 * duplicate it rather than attempt to ensure some arbitrary
1558 * ordering of calls.
1561 drm_add_display_info(connector, edid);
1563 drm_reset_display_info(connector);
1565 drm_object_property_set_value(&connector->base,
1566 dev->mode_config.non_desktop_property,
1567 connector->display_info.non_desktop);
1569 ret = drm_property_replace_global_blob(dev,
1570 &connector->edid_blob_ptr,
1574 dev->mode_config.edid_property);
1577 EXPORT_SYMBOL(drm_connector_update_edid_property);
1580 * drm_connector_set_link_status_property - Set link status property of a connector
1581 * @connector: drm connector
1582 * @link_status: new value of link status property (0: Good, 1: Bad)
1584 * In usual working scenario, this link status property will always be set to
1585 * "GOOD". If something fails during or after a mode set, the kernel driver
1586 * may set this link status property to "BAD". The caller then needs to send a
1587 * hotplug uevent for userspace to re-check the valid modes through
1588 * GET_CONNECTOR_IOCTL and retry modeset.
1590 * Note: Drivers cannot rely on userspace to support this property and
1591 * issue a modeset. As such, they may choose to handle issues (like
1592 * re-training a link) without userspace's intervention.
1594 * The reason for adding this property is to handle link training failures, but
1595 * it is not limited to DP or link training. For example, if we implement
1596 * asynchronous setcrtc, this property can be used to report any failures in that.
1598 void drm_connector_set_link_status_property(struct drm_connector *connector,
1599 uint64_t link_status)
1601 struct drm_device *dev = connector->dev;
1603 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
1604 connector->state->link_status = link_status;
1605 drm_modeset_unlock(&dev->mode_config.connection_mutex);
1607 EXPORT_SYMBOL(drm_connector_set_link_status_property);
1610 * drm_connector_attach_max_bpc_property - attach "max bpc" property
1611 * @connector: connector to attach max bpc property on.
1612 * @min: The minimum bit depth supported by the connector.
1613 * @max: The maximum bit depth supported by the connector.
1615 * This is used to add support for limiting the bit depth on a connector.
1618 * Zero on success, negative errno on failure.
1620 int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
1623 struct drm_device *dev = connector->dev;
1624 struct drm_property *prop;
1626 prop = connector->max_bpc_property;
1628 prop = drm_property_create_range(dev, 0, "max bpc", min, max);
1632 connector->max_bpc_property = prop;
1635 drm_object_attach_property(&connector->base, prop, max);
1636 connector->state->max_requested_bpc = max;
1637 connector->state->max_bpc = max;
1641 EXPORT_SYMBOL(drm_connector_attach_max_bpc_property);
1644 * drm_connector_init_panel_orientation_property -
1645 * initialize the connecters panel_orientation property
1646 * @connector: connector for which to init the panel-orientation property.
1647 * @width: width in pixels of the panel, used for panel quirk detection
1648 * @height: height in pixels of the panel, used for panel quirk detection
1650 * This function should only be called for built-in panels, after setting
1651 * connector->display_info.panel_orientation first (if known).
1653 * This function will check for platform specific (e.g. DMI based) quirks
1654 * overriding display_info.panel_orientation first, then if panel_orientation
1655 * is not DRM_MODE_PANEL_ORIENTATION_UNKNOWN it will attach the
1656 * "panel orientation" property to the connector.
1659 * Zero on success, negative errno on failure.
1661 int drm_connector_init_panel_orientation_property(
1662 struct drm_connector *connector, int width, int height)
1664 struct drm_device *dev = connector->dev;
1665 struct drm_display_info *info = &connector->display_info;
1666 struct drm_property *prop;
1667 int orientation_quirk;
1669 orientation_quirk = drm_get_panel_orientation_quirk(width, height);
1670 if (orientation_quirk != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
1671 info->panel_orientation = orientation_quirk;
1673 if (info->panel_orientation == DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
1676 prop = dev->mode_config.panel_orientation_property;
1678 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1679 "panel orientation",
1680 drm_panel_orientation_enum_list,
1681 ARRAY_SIZE(drm_panel_orientation_enum_list));
1685 dev->mode_config.panel_orientation_property = prop;
1688 drm_object_attach_property(&connector->base, prop,
1689 info->panel_orientation);
1692 EXPORT_SYMBOL(drm_connector_init_panel_orientation_property);
1694 int drm_connector_set_obj_prop(struct drm_mode_object *obj,
1695 struct drm_property *property,
1699 struct drm_connector *connector = obj_to_connector(obj);
1701 /* Do DPMS ourselves */
1702 if (property == connector->dev->mode_config.dpms_property) {
1703 ret = (*connector->funcs->dpms)(connector, (int)value);
1704 } else if (connector->funcs->set_property)
1705 ret = connector->funcs->set_property(connector, property, value);
1708 drm_object_property_set_value(&connector->base, property, value);
1712 int drm_connector_property_set_ioctl(struct drm_device *dev,
1713 void *data, struct drm_file *file_priv)
1715 struct drm_mode_connector_set_property *conn_set_prop = data;
1716 struct drm_mode_obj_set_property obj_set_prop = {
1717 .value = conn_set_prop->value,
1718 .prop_id = conn_set_prop->prop_id,
1719 .obj_id = conn_set_prop->connector_id,
1720 .obj_type = DRM_MODE_OBJECT_CONNECTOR
1723 /* It does all the locking and checking we need */
1724 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
1727 static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
1729 /* For atomic drivers only state objects are synchronously updated and
1730 * protected by modeset locks, so check those first. */
1731 if (connector->state)
1732 return connector->state->best_encoder;
1733 return connector->encoder;
1737 drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
1738 const struct list_head *export_list,
1739 const struct drm_file *file_priv)
1742 * If user-space hasn't configured the driver to expose the stereo 3D
1743 * modes, don't expose them.
1745 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
1748 * If user-space hasn't configured the driver to expose the modes
1749 * with aspect-ratio, don't expose them. However if such a mode
1750 * is unique, let it be exposed, but reset the aspect-ratio flags
1751 * while preparing the list of user-modes.
1753 if (!file_priv->aspect_ratio_allowed) {
1754 struct drm_display_mode *mode_itr;
1756 list_for_each_entry(mode_itr, export_list, export_head)
1757 if (drm_mode_match(mode_itr, mode,
1758 DRM_MODE_MATCH_TIMINGS |
1759 DRM_MODE_MATCH_CLOCK |
1760 DRM_MODE_MATCH_FLAGS |
1761 DRM_MODE_MATCH_3D_FLAGS))
1768 int drm_mode_getconnector(struct drm_device *dev, void *data,
1769 struct drm_file *file_priv)
1771 struct drm_mode_get_connector *out_resp = data;
1772 struct drm_connector *connector;
1773 struct drm_encoder *encoder;
1774 struct drm_display_mode *mode;
1776 int encoders_count = 0;
1780 struct drm_mode_modeinfo u_mode;
1781 struct drm_mode_modeinfo __user *mode_ptr;
1782 uint32_t __user *encoder_ptr;
1783 LIST_HEAD(export_list);
1785 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1788 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
1790 connector = drm_connector_lookup(dev, file_priv, out_resp->connector_id);
1794 drm_connector_for_each_possible_encoder(connector, encoder, i)
1797 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
1799 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
1801 drm_connector_for_each_possible_encoder(connector, encoder, i) {
1802 if (put_user(encoder->base.id, encoder_ptr + copied)) {
1809 out_resp->count_encoders = encoders_count;
1811 out_resp->connector_id = connector->base.id;
1812 out_resp->connector_type = connector->connector_type;
1813 out_resp->connector_type_id = connector->connector_type_id;
1815 mutex_lock(&dev->mode_config.mutex);
1816 if (out_resp->count_modes == 0) {
1817 connector->funcs->fill_modes(connector,
1818 dev->mode_config.max_width,
1819 dev->mode_config.max_height);
1822 out_resp->mm_width = connector->display_info.width_mm;
1823 out_resp->mm_height = connector->display_info.height_mm;
1824 out_resp->subpixel = connector->display_info.subpixel_order;
1825 out_resp->connection = connector->status;
1827 /* delayed so we get modes regardless of pre-fill_modes state */
1828 list_for_each_entry(mode, &connector->modes, head)
1829 if (drm_mode_expose_to_userspace(mode, &export_list,
1831 list_add_tail(&mode->export_head, &export_list);
1836 * This ioctl is called twice, once to determine how much space is
1837 * needed, and the 2nd time to fill it.
1838 * The modes that need to be exposed to the user are maintained in the
1839 * 'export_list'. When the ioctl is called first time to determine the,
1840 * space, the export_list gets filled, to find the no.of modes. In the
1841 * 2nd time, the user modes are filled, one by one from the export_list.
1843 if ((out_resp->count_modes >= mode_count) && mode_count) {
1845 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
1846 list_for_each_entry(mode, &export_list, export_head) {
1847 drm_mode_convert_to_umode(&u_mode, mode);
1849 * Reset aspect ratio flags of user-mode, if modes with
1850 * aspect-ratio are not supported.
1852 if (!file_priv->aspect_ratio_allowed)
1853 u_mode.flags &= ~DRM_MODE_FLAG_PIC_AR_MASK;
1854 if (copy_to_user(mode_ptr + copied,
1855 &u_mode, sizeof(u_mode))) {
1857 mutex_unlock(&dev->mode_config.mutex);
1864 out_resp->count_modes = mode_count;
1865 mutex_unlock(&dev->mode_config.mutex);
1867 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
1868 encoder = drm_connector_get_encoder(connector);
1870 out_resp->encoder_id = encoder->base.id;
1872 out_resp->encoder_id = 0;
1874 /* Only grab properties after probing, to make sure EDID and other
1875 * properties reflect the latest status. */
1876 ret = drm_mode_object_get_properties(&connector->base, file_priv->atomic,
1877 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
1878 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
1879 &out_resp->count_props);
1880 drm_modeset_unlock(&dev->mode_config.connection_mutex);
1883 drm_connector_put(connector);
1892 * Tile groups are used to represent tiled monitors with a unique integer
1893 * identifier. Tiled monitors using DisplayID v1.3 have a unique 8-byte handle,
1894 * we store this in a tile group, so we have a common identifier for all tiles
1895 * in a monitor group. The property is called "TILE". Drivers can manage tile
1896 * groups using drm_mode_create_tile_group(), drm_mode_put_tile_group() and
1897 * drm_mode_get_tile_group(). But this is only needed for internal panels where
1898 * the tile group information is exposed through a non-standard way.
1901 static void drm_tile_group_free(struct kref *kref)
1903 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
1904 struct drm_device *dev = tg->dev;
1905 mutex_lock(&dev->mode_config.idr_mutex);
1906 idr_remove(&dev->mode_config.tile_idr, tg->id);
1907 mutex_unlock(&dev->mode_config.idr_mutex);
1912 * drm_mode_put_tile_group - drop a reference to a tile group.
1914 * @tg: tile group to drop reference to.
1916 * drop reference to tile group and free if 0.
1918 void drm_mode_put_tile_group(struct drm_device *dev,
1919 struct drm_tile_group *tg)
1921 kref_put(&tg->refcount, drm_tile_group_free);
1923 EXPORT_SYMBOL(drm_mode_put_tile_group);
1926 * drm_mode_get_tile_group - get a reference to an existing tile group
1928 * @topology: 8-bytes unique per monitor.
1930 * Use the unique bytes to get a reference to an existing tile group.
1933 * tile group or NULL if not found.
1935 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1938 struct drm_tile_group *tg;
1940 mutex_lock(&dev->mode_config.idr_mutex);
1941 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
1942 if (!memcmp(tg->group_data, topology, 8)) {
1943 if (!kref_get_unless_zero(&tg->refcount))
1945 mutex_unlock(&dev->mode_config.idr_mutex);
1949 mutex_unlock(&dev->mode_config.idr_mutex);
1952 EXPORT_SYMBOL(drm_mode_get_tile_group);
1955 * drm_mode_create_tile_group - create a tile group from a displayid description
1957 * @topology: 8-bytes unique per monitor.
1959 * Create a tile group for the unique monitor, and get a unique
1960 * identifier for the tile group.
1963 * new tile group or error.
1965 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1968 struct drm_tile_group *tg;
1971 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
1973 return ERR_PTR(-ENOMEM);
1975 kref_init(&tg->refcount);
1976 memcpy(tg->group_data, topology, 8);
1979 mutex_lock(&dev->mode_config.idr_mutex);
1980 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
1988 mutex_unlock(&dev->mode_config.idr_mutex);
1991 EXPORT_SYMBOL(drm_mode_create_tile_group);