2 * Copyright (c) 2016 Intel Corporation
4 * Permission to use, copy, modify, distribute, and sell this software and its
5 * documentation for any purpose is hereby granted without fee, provided that
6 * the above copyright notice appear in all copies and that both that copyright
7 * notice and this permission notice appear in supporting documentation, and
8 * that the name of the copyright holders not be used in advertising or
9 * publicity pertaining to distribution of the software without specific,
10 * written prior permission. The copyright holders make no representations
11 * about the suitability of this software for any purpose. It is provided "as
12 * is" without express or implied warranty.
14 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
23 #include <drm/drm_connector.h>
24 #include <drm/drm_edid.h>
25 #include <drm/drm_encoder.h>
26 #include <drm/drm_utils.h>
27 #include <drm/drm_print.h>
28 #include <drm/drm_drv.h>
29 #include <drm/drm_file.h>
30 #include <drm/drm_sysfs.h>
32 #include <linux/uaccess.h>
34 #include "drm_crtc_internal.h"
35 #include "drm_internal.h"
40 * In DRM connectors are the general abstraction for display sinks, and include
41 * als fixed panels or anything else that can display pixels in some form. As
42 * opposed to all other KMS objects representing hardware (like CRTC, encoder or
43 * plane abstractions) connectors can be hotplugged and unplugged at runtime.
44 * Hence they are reference-counted using drm_connector_get() and
45 * drm_connector_put().
47 * KMS driver must create, initialize, register and attach at a &struct
48 * drm_connector for each such sink. The instance is created as other KMS
49 * objects and initialized by setting the following fields. The connector is
50 * initialized with a call to drm_connector_init() with a pointer to the
51 * &struct drm_connector_funcs and a connector type, and then exposed to
52 * userspace with a call to drm_connector_register().
54 * Connectors must be attached to an encoder to be used. For devices that map
55 * connectors to encoders 1:1, the connector should be attached at
56 * initialization time with a call to drm_connector_attach_encoder(). The
57 * driver must also set the &drm_connector.encoder field to point to the
60 * For connectors which are not fixed (like built-in panels) the driver needs to
61 * support hotplug notifications. The simplest way to do that is by using the
62 * probe helpers, see drm_kms_helper_poll_init() for connectors which don't have
63 * hardware support for hotplug interrupts. Connectors with hardware hotplug
64 * support can instead use e.g. drm_helper_hpd_irq_event().
67 struct drm_conn_prop_enum_list
{
74 * Connector and encoder types.
76 static struct drm_conn_prop_enum_list drm_connector_enum_list
[] = {
77 { DRM_MODE_CONNECTOR_Unknown
, "Unknown" },
78 { DRM_MODE_CONNECTOR_VGA
, "VGA" },
79 { DRM_MODE_CONNECTOR_DVII
, "DVI-I" },
80 { DRM_MODE_CONNECTOR_DVID
, "DVI-D" },
81 { DRM_MODE_CONNECTOR_DVIA
, "DVI-A" },
82 { DRM_MODE_CONNECTOR_Composite
, "Composite" },
83 { DRM_MODE_CONNECTOR_SVIDEO
, "SVIDEO" },
84 { DRM_MODE_CONNECTOR_LVDS
, "LVDS" },
85 { DRM_MODE_CONNECTOR_Component
, "Component" },
86 { DRM_MODE_CONNECTOR_9PinDIN
, "DIN" },
87 { DRM_MODE_CONNECTOR_DisplayPort
, "DP" },
88 { DRM_MODE_CONNECTOR_HDMIA
, "HDMI-A" },
89 { DRM_MODE_CONNECTOR_HDMIB
, "HDMI-B" },
90 { DRM_MODE_CONNECTOR_TV
, "TV" },
91 { DRM_MODE_CONNECTOR_eDP
, "eDP" },
92 { DRM_MODE_CONNECTOR_VIRTUAL
, "Virtual" },
93 { DRM_MODE_CONNECTOR_DSI
, "DSI" },
94 { DRM_MODE_CONNECTOR_DPI
, "DPI" },
95 { DRM_MODE_CONNECTOR_WRITEBACK
, "Writeback" },
96 { DRM_MODE_CONNECTOR_SPI
, "SPI" },
99 void drm_connector_ida_init(void)
103 for (i
= 0; i
< ARRAY_SIZE(drm_connector_enum_list
); i
++)
104 ida_init(&drm_connector_enum_list
[i
].ida
);
107 void drm_connector_ida_destroy(void)
111 for (i
= 0; i
< ARRAY_SIZE(drm_connector_enum_list
); i
++)
112 ida_destroy(&drm_connector_enum_list
[i
].ida
);
116 * drm_get_connector_type_name - return a string for connector type
117 * @type: The connector type (DRM_MODE_CONNECTOR_*)
119 * Returns: the name of the connector type, or NULL if the type is not valid.
121 const char *drm_get_connector_type_name(unsigned int type
)
123 if (type
< ARRAY_SIZE(drm_connector_enum_list
))
124 return drm_connector_enum_list
[type
].name
;
128 EXPORT_SYMBOL(drm_get_connector_type_name
);
131 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
132 * @connector: connector to quwery
134 * The kernel supports per-connector configuration of its consoles through
135 * use of the video= parameter. This function parses that option and
136 * extracts the user's specified mode (or enable/disable status) for a
137 * particular connector. This is typically only used during the early fbdev
140 static void drm_connector_get_cmdline_mode(struct drm_connector
*connector
)
142 struct drm_cmdline_mode
*mode
= &connector
->cmdline_mode
;
145 if (fb_get_options(connector
->name
, &option
))
148 if (!drm_mode_parse_command_line_for_connector(option
,
154 DRM_INFO("forcing %s connector %s\n", connector
->name
,
155 drm_get_connector_force_name(mode
->force
));
156 connector
->force
= mode
->force
;
159 if (mode
->panel_orientation
!= DRM_MODE_PANEL_ORIENTATION_UNKNOWN
) {
160 DRM_INFO("cmdline forces connector %s panel_orientation to %d\n",
161 connector
->name
, mode
->panel_orientation
);
162 drm_connector_set_panel_orientation(connector
,
163 mode
->panel_orientation
);
166 DRM_DEBUG_KMS("cmdline mode for connector %s %s %dx%d@%dHz%s%s%s\n",
167 connector
->name
, mode
->name
,
168 mode
->xres
, mode
->yres
,
169 mode
->refresh_specified
? mode
->refresh
: 60,
170 mode
->rb
? " reduced blanking" : "",
171 mode
->margins
? " with margins" : "",
172 mode
->interlace
? " interlaced" : "");
175 static void drm_connector_free(struct kref
*kref
)
177 struct drm_connector
*connector
=
178 container_of(kref
, struct drm_connector
, base
.refcount
);
179 struct drm_device
*dev
= connector
->dev
;
181 drm_mode_object_unregister(dev
, &connector
->base
);
182 connector
->funcs
->destroy(connector
);
185 void drm_connector_free_work_fn(struct work_struct
*work
)
187 struct drm_connector
*connector
, *n
;
188 struct drm_device
*dev
=
189 container_of(work
, struct drm_device
, mode_config
.connector_free_work
);
190 struct drm_mode_config
*config
= &dev
->mode_config
;
192 struct llist_node
*freed
;
194 spin_lock_irqsave(&config
->connector_list_lock
, flags
);
195 freed
= llist_del_all(&config
->connector_free_list
);
196 spin_unlock_irqrestore(&config
->connector_list_lock
, flags
);
198 llist_for_each_entry_safe(connector
, n
, freed
, free_node
) {
199 drm_mode_object_unregister(dev
, &connector
->base
);
200 connector
->funcs
->destroy(connector
);
205 * drm_connector_init - Init a preallocated connector
207 * @connector: the connector to init
208 * @funcs: callbacks for this connector
209 * @connector_type: user visible type of the connector
211 * Initialises a preallocated connector. Connectors should be
212 * subclassed as part of driver connector objects.
215 * Zero on success, error code on failure.
217 int drm_connector_init(struct drm_device
*dev
,
218 struct drm_connector
*connector
,
219 const struct drm_connector_funcs
*funcs
,
222 struct drm_mode_config
*config
= &dev
->mode_config
;
224 struct ida
*connector_ida
=
225 &drm_connector_enum_list
[connector_type
].ida
;
227 WARN_ON(drm_drv_uses_atomic_modeset(dev
) &&
228 (!funcs
->atomic_destroy_state
||
229 !funcs
->atomic_duplicate_state
));
231 ret
= __drm_mode_object_add(dev
, &connector
->base
,
232 DRM_MODE_OBJECT_CONNECTOR
,
233 false, drm_connector_free
);
237 connector
->base
.properties
= &connector
->properties
;
238 connector
->dev
= dev
;
239 connector
->funcs
= funcs
;
241 /* connector index is used with 32bit bitmasks */
242 ret
= ida_simple_get(&config
->connector_ida
, 0, 32, GFP_KERNEL
);
244 DRM_DEBUG_KMS("Failed to allocate %s connector index: %d\n",
245 drm_connector_enum_list
[connector_type
].name
,
249 connector
->index
= ret
;
252 connector
->connector_type
= connector_type
;
253 connector
->connector_type_id
=
254 ida_simple_get(connector_ida
, 1, 0, GFP_KERNEL
);
255 if (connector
->connector_type_id
< 0) {
256 ret
= connector
->connector_type_id
;
260 kasprintf(GFP_KERNEL
, "%s-%d",
261 drm_connector_enum_list
[connector_type
].name
,
262 connector
->connector_type_id
);
263 if (!connector
->name
) {
265 goto out_put_type_id
;
268 INIT_LIST_HEAD(&connector
->probed_modes
);
269 INIT_LIST_HEAD(&connector
->modes
);
270 mutex_init(&connector
->mutex
);
271 connector
->edid_blob_ptr
= NULL
;
272 connector
->tile_blob_ptr
= NULL
;
273 connector
->status
= connector_status_unknown
;
274 connector
->display_info
.panel_orientation
=
275 DRM_MODE_PANEL_ORIENTATION_UNKNOWN
;
277 drm_connector_get_cmdline_mode(connector
);
279 /* We should add connectors at the end to avoid upsetting the connector
281 spin_lock_irq(&config
->connector_list_lock
);
282 list_add_tail(&connector
->head
, &config
->connector_list
);
283 config
->num_connector
++;
284 spin_unlock_irq(&config
->connector_list_lock
);
286 if (connector_type
!= DRM_MODE_CONNECTOR_VIRTUAL
&&
287 connector_type
!= DRM_MODE_CONNECTOR_WRITEBACK
)
288 drm_connector_attach_edid_property(connector
);
290 drm_object_attach_property(&connector
->base
,
291 config
->dpms_property
, 0);
293 drm_object_attach_property(&connector
->base
,
294 config
->link_status_property
,
297 drm_object_attach_property(&connector
->base
,
298 config
->non_desktop_property
,
300 drm_object_attach_property(&connector
->base
,
301 config
->tile_property
,
304 if (drm_core_check_feature(dev
, DRIVER_ATOMIC
)) {
305 drm_object_attach_property(&connector
->base
, config
->prop_crtc_id
, 0);
308 connector
->debugfs_entry
= NULL
;
311 ida_simple_remove(connector_ida
, connector
->connector_type_id
);
314 ida_simple_remove(&config
->connector_ida
, connector
->index
);
317 drm_mode_object_unregister(dev
, &connector
->base
);
321 EXPORT_SYMBOL(drm_connector_init
);
324 * drm_connector_init_with_ddc - Init a preallocated connector
326 * @connector: the connector to init
327 * @funcs: callbacks for this connector
328 * @connector_type: user visible type of the connector
329 * @ddc: pointer to the associated ddc adapter
331 * Initialises a preallocated connector. Connectors should be
332 * subclassed as part of driver connector objects.
334 * Ensures that the ddc field of the connector is correctly set.
337 * Zero on success, error code on failure.
339 int drm_connector_init_with_ddc(struct drm_device
*dev
,
340 struct drm_connector
*connector
,
341 const struct drm_connector_funcs
*funcs
,
343 struct i2c_adapter
*ddc
)
347 ret
= drm_connector_init(dev
, connector
, funcs
, connector_type
);
351 /* provide ddc symlink in sysfs */
352 connector
->ddc
= ddc
;
356 EXPORT_SYMBOL(drm_connector_init_with_ddc
);
359 * drm_connector_attach_edid_property - attach edid property.
360 * @connector: the connector
362 * Some connector types like DRM_MODE_CONNECTOR_VIRTUAL do not get a
363 * edid property attached by default. This function can be used to
364 * explicitly enable the edid property in these cases.
366 void drm_connector_attach_edid_property(struct drm_connector
*connector
)
368 struct drm_mode_config
*config
= &connector
->dev
->mode_config
;
370 drm_object_attach_property(&connector
->base
,
371 config
->edid_property
,
374 EXPORT_SYMBOL(drm_connector_attach_edid_property
);
377 * drm_connector_attach_encoder - attach a connector to an encoder
378 * @connector: connector to attach
379 * @encoder: encoder to attach @connector to
381 * This function links up a connector to an encoder. Note that the routing
382 * restrictions between encoders and crtcs are exposed to userspace through the
383 * possible_clones and possible_crtcs bitmasks.
386 * Zero on success, negative errno on failure.
388 int drm_connector_attach_encoder(struct drm_connector
*connector
,
389 struct drm_encoder
*encoder
)
392 * In the past, drivers have attempted to model the static association
393 * of connector to encoder in simple connector/encoder devices using a
394 * direct assignment of connector->encoder = encoder. This connection
395 * is a logical one and the responsibility of the core, so drivers are
396 * expected not to mess with this.
398 * Note that the error return should've been enough here, but a large
399 * majority of drivers ignores the return value, so add in a big WARN
400 * to get people's attention.
402 if (WARN_ON(connector
->encoder
))
405 connector
->possible_encoders
|= drm_encoder_mask(encoder
);
409 EXPORT_SYMBOL(drm_connector_attach_encoder
);
412 * drm_connector_has_possible_encoder - check if the connector and encoder are
413 * associated with each other
414 * @connector: the connector
415 * @encoder: the encoder
418 * True if @encoder is one of the possible encoders for @connector.
420 bool drm_connector_has_possible_encoder(struct drm_connector
*connector
,
421 struct drm_encoder
*encoder
)
423 return connector
->possible_encoders
& drm_encoder_mask(encoder
);
425 EXPORT_SYMBOL(drm_connector_has_possible_encoder
);
427 static void drm_mode_remove(struct drm_connector
*connector
,
428 struct drm_display_mode
*mode
)
430 list_del(&mode
->head
);
431 drm_mode_destroy(connector
->dev
, mode
);
435 * drm_connector_cleanup - cleans up an initialised connector
436 * @connector: connector to cleanup
438 * Cleans up the connector but doesn't free the object.
440 void drm_connector_cleanup(struct drm_connector
*connector
)
442 struct drm_device
*dev
= connector
->dev
;
443 struct drm_display_mode
*mode
, *t
;
445 /* The connector should have been removed from userspace long before
446 * it is finally destroyed.
448 if (WARN_ON(connector
->registration_state
==
449 DRM_CONNECTOR_REGISTERED
))
450 drm_connector_unregister(connector
);
452 if (connector
->tile_group
) {
453 drm_mode_put_tile_group(dev
, connector
->tile_group
);
454 connector
->tile_group
= NULL
;
457 list_for_each_entry_safe(mode
, t
, &connector
->probed_modes
, head
)
458 drm_mode_remove(connector
, mode
);
460 list_for_each_entry_safe(mode
, t
, &connector
->modes
, head
)
461 drm_mode_remove(connector
, mode
);
463 ida_simple_remove(&drm_connector_enum_list
[connector
->connector_type
].ida
,
464 connector
->connector_type_id
);
466 ida_simple_remove(&dev
->mode_config
.connector_ida
,
469 kfree(connector
->display_info
.bus_formats
);
470 drm_mode_object_unregister(dev
, &connector
->base
);
471 kfree(connector
->name
);
472 connector
->name
= NULL
;
473 spin_lock_irq(&dev
->mode_config
.connector_list_lock
);
474 list_del(&connector
->head
);
475 dev
->mode_config
.num_connector
--;
476 spin_unlock_irq(&dev
->mode_config
.connector_list_lock
);
478 WARN_ON(connector
->state
&& !connector
->funcs
->atomic_destroy_state
);
479 if (connector
->state
&& connector
->funcs
->atomic_destroy_state
)
480 connector
->funcs
->atomic_destroy_state(connector
,
483 mutex_destroy(&connector
->mutex
);
485 memset(connector
, 0, sizeof(*connector
));
487 EXPORT_SYMBOL(drm_connector_cleanup
);
490 * drm_connector_register - register a connector
491 * @connector: the connector to register
493 * Register userspace interfaces for a connector. Only call this for connectors
494 * which can be hotplugged after drm_dev_register() has been called already,
495 * e.g. DP MST connectors. All other connectors will be registered automatically
496 * when calling drm_dev_register().
499 * Zero on success, error code on failure.
501 int drm_connector_register(struct drm_connector
*connector
)
505 if (!connector
->dev
->registered
)
508 mutex_lock(&connector
->mutex
);
509 if (connector
->registration_state
!= DRM_CONNECTOR_INITIALIZING
)
512 ret
= drm_sysfs_connector_add(connector
);
516 drm_debugfs_connector_add(connector
);
518 if (connector
->funcs
->late_register
) {
519 ret
= connector
->funcs
->late_register(connector
);
524 drm_mode_object_register(connector
->dev
, &connector
->base
);
526 connector
->registration_state
= DRM_CONNECTOR_REGISTERED
;
528 /* Let userspace know we have a new connector */
529 drm_sysfs_hotplug_event(connector
->dev
);
534 drm_debugfs_connector_remove(connector
);
535 drm_sysfs_connector_remove(connector
);
537 mutex_unlock(&connector
->mutex
);
540 EXPORT_SYMBOL(drm_connector_register
);
543 * drm_connector_unregister - unregister a connector
544 * @connector: the connector to unregister
546 * Unregister userspace interfaces for a connector. Only call this for
547 * connectors which have registered explicitly by calling drm_dev_register(),
548 * since connectors are unregistered automatically when drm_dev_unregister() is
551 void drm_connector_unregister(struct drm_connector
*connector
)
553 mutex_lock(&connector
->mutex
);
554 if (connector
->registration_state
!= DRM_CONNECTOR_REGISTERED
) {
555 mutex_unlock(&connector
->mutex
);
559 if (connector
->funcs
->early_unregister
)
560 connector
->funcs
->early_unregister(connector
);
562 drm_sysfs_connector_remove(connector
);
563 drm_debugfs_connector_remove(connector
);
565 connector
->registration_state
= DRM_CONNECTOR_UNREGISTERED
;
566 mutex_unlock(&connector
->mutex
);
568 EXPORT_SYMBOL(drm_connector_unregister
);
570 void drm_connector_unregister_all(struct drm_device
*dev
)
572 struct drm_connector
*connector
;
573 struct drm_connector_list_iter conn_iter
;
575 drm_connector_list_iter_begin(dev
, &conn_iter
);
576 drm_for_each_connector_iter(connector
, &conn_iter
)
577 drm_connector_unregister(connector
);
578 drm_connector_list_iter_end(&conn_iter
);
581 int drm_connector_register_all(struct drm_device
*dev
)
583 struct drm_connector
*connector
;
584 struct drm_connector_list_iter conn_iter
;
587 drm_connector_list_iter_begin(dev
, &conn_iter
);
588 drm_for_each_connector_iter(connector
, &conn_iter
) {
589 ret
= drm_connector_register(connector
);
593 drm_connector_list_iter_end(&conn_iter
);
596 drm_connector_unregister_all(dev
);
601 * drm_get_connector_status_name - return a string for connector status
602 * @status: connector status to compute name of
604 * In contrast to the other drm_get_*_name functions this one here returns a
605 * const pointer and hence is threadsafe.
607 const char *drm_get_connector_status_name(enum drm_connector_status status
)
609 if (status
== connector_status_connected
)
611 else if (status
== connector_status_disconnected
)
612 return "disconnected";
616 EXPORT_SYMBOL(drm_get_connector_status_name
);
619 * drm_get_connector_force_name - return a string for connector force
620 * @force: connector force to get name of
622 * Returns: const pointer to name.
624 const char *drm_get_connector_force_name(enum drm_connector_force force
)
627 case DRM_FORCE_UNSPECIFIED
:
628 return "unspecified";
633 case DRM_FORCE_ON_DIGITAL
:
640 #ifdef CONFIG_LOCKDEP
641 static struct lockdep_map connector_list_iter_dep_map
= {
642 .name
= "drm_connector_list_iter"
647 * drm_connector_list_iter_begin - initialize a connector_list iterator
649 * @iter: connector_list iterator
651 * Sets @iter up to walk the &drm_mode_config.connector_list of @dev. @iter
652 * must always be cleaned up again by calling drm_connector_list_iter_end().
653 * Iteration itself happens using drm_connector_list_iter_next() or
654 * drm_for_each_connector_iter().
656 void drm_connector_list_iter_begin(struct drm_device
*dev
,
657 struct drm_connector_list_iter
*iter
)
661 lock_acquire_shared_recursive(&connector_list_iter_dep_map
, 0, 1, NULL
, _RET_IP_
);
663 EXPORT_SYMBOL(drm_connector_list_iter_begin
);
666 * Extra-safe connector put function that works in any context. Should only be
667 * used from the connector_iter functions, where we never really expect to
668 * actually release the connector when dropping our final reference.
671 __drm_connector_put_safe(struct drm_connector
*conn
)
673 struct drm_mode_config
*config
= &conn
->dev
->mode_config
;
675 lockdep_assert_held(&config
->connector_list_lock
);
677 if (!refcount_dec_and_test(&conn
->base
.refcount
.refcount
))
680 llist_add(&conn
->free_node
, &config
->connector_free_list
);
681 schedule_work(&config
->connector_free_work
);
685 * drm_connector_list_iter_next - return next connector
686 * @iter: connector_list iterator
688 * Returns the next connector for @iter, or NULL when the list walk has
691 struct drm_connector
*
692 drm_connector_list_iter_next(struct drm_connector_list_iter
*iter
)
694 struct drm_connector
*old_conn
= iter
->conn
;
695 struct drm_mode_config
*config
= &iter
->dev
->mode_config
;
696 struct list_head
*lhead
;
699 spin_lock_irqsave(&config
->connector_list_lock
, flags
);
700 lhead
= old_conn
? &old_conn
->head
: &config
->connector_list
;
703 if (lhead
->next
== &config
->connector_list
) {
709 iter
->conn
= list_entry(lhead
, struct drm_connector
, head
);
711 /* loop until it's not a zombie connector */
712 } while (!kref_get_unless_zero(&iter
->conn
->base
.refcount
));
715 __drm_connector_put_safe(old_conn
);
716 spin_unlock_irqrestore(&config
->connector_list_lock
, flags
);
720 EXPORT_SYMBOL(drm_connector_list_iter_next
);
723 * drm_connector_list_iter_end - tear down a connector_list iterator
724 * @iter: connector_list iterator
726 * Tears down @iter and releases any resources (like &drm_connector references)
727 * acquired while walking the list. This must always be called, both when the
728 * iteration completes fully or when it was aborted without walking the entire
731 void drm_connector_list_iter_end(struct drm_connector_list_iter
*iter
)
733 struct drm_mode_config
*config
= &iter
->dev
->mode_config
;
738 spin_lock_irqsave(&config
->connector_list_lock
, flags
);
739 __drm_connector_put_safe(iter
->conn
);
740 spin_unlock_irqrestore(&config
->connector_list_lock
, flags
);
742 lock_release(&connector_list_iter_dep_map
, _RET_IP_
);
744 EXPORT_SYMBOL(drm_connector_list_iter_end
);
746 static const struct drm_prop_enum_list drm_subpixel_enum_list
[] = {
747 { SubPixelUnknown
, "Unknown" },
748 { SubPixelHorizontalRGB
, "Horizontal RGB" },
749 { SubPixelHorizontalBGR
, "Horizontal BGR" },
750 { SubPixelVerticalRGB
, "Vertical RGB" },
751 { SubPixelVerticalBGR
, "Vertical BGR" },
752 { SubPixelNone
, "None" },
756 * drm_get_subpixel_order_name - return a string for a given subpixel enum
757 * @order: enum of subpixel_order
759 * Note you could abuse this and return something out of bounds, but that
760 * would be a caller error. No unscrubbed user data should make it here.
762 const char *drm_get_subpixel_order_name(enum subpixel_order order
)
764 return drm_subpixel_enum_list
[order
].name
;
766 EXPORT_SYMBOL(drm_get_subpixel_order_name
);
768 static const struct drm_prop_enum_list drm_dpms_enum_list
[] = {
769 { DRM_MODE_DPMS_ON
, "On" },
770 { DRM_MODE_DPMS_STANDBY
, "Standby" },
771 { DRM_MODE_DPMS_SUSPEND
, "Suspend" },
772 { DRM_MODE_DPMS_OFF
, "Off" }
774 DRM_ENUM_NAME_FN(drm_get_dpms_name
, drm_dpms_enum_list
)
776 static const struct drm_prop_enum_list drm_link_status_enum_list
[] = {
777 { DRM_MODE_LINK_STATUS_GOOD
, "Good" },
778 { DRM_MODE_LINK_STATUS_BAD
, "Bad" },
782 * drm_display_info_set_bus_formats - set the supported bus formats
783 * @info: display info to store bus formats in
784 * @formats: array containing the supported bus formats
785 * @num_formats: the number of entries in the fmts array
787 * Store the supported bus formats in display info structure.
788 * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
789 * a full list of available formats.
791 int drm_display_info_set_bus_formats(struct drm_display_info
*info
,
793 unsigned int num_formats
)
797 if (!formats
&& num_formats
)
800 if (formats
&& num_formats
) {
801 fmts
= kmemdup(formats
, sizeof(*formats
) * num_formats
,
807 kfree(info
->bus_formats
);
808 info
->bus_formats
= fmts
;
809 info
->num_bus_formats
= num_formats
;
813 EXPORT_SYMBOL(drm_display_info_set_bus_formats
);
815 /* Optional connector properties. */
816 static const struct drm_prop_enum_list drm_scaling_mode_enum_list
[] = {
817 { DRM_MODE_SCALE_NONE
, "None" },
818 { DRM_MODE_SCALE_FULLSCREEN
, "Full" },
819 { DRM_MODE_SCALE_CENTER
, "Center" },
820 { DRM_MODE_SCALE_ASPECT
, "Full aspect" },
823 static const struct drm_prop_enum_list drm_aspect_ratio_enum_list
[] = {
824 { DRM_MODE_PICTURE_ASPECT_NONE
, "Automatic" },
825 { DRM_MODE_PICTURE_ASPECT_4_3
, "4:3" },
826 { DRM_MODE_PICTURE_ASPECT_16_9
, "16:9" },
829 static const struct drm_prop_enum_list drm_content_type_enum_list
[] = {
830 { DRM_MODE_CONTENT_TYPE_NO_DATA
, "No Data" },
831 { DRM_MODE_CONTENT_TYPE_GRAPHICS
, "Graphics" },
832 { DRM_MODE_CONTENT_TYPE_PHOTO
, "Photo" },
833 { DRM_MODE_CONTENT_TYPE_CINEMA
, "Cinema" },
834 { DRM_MODE_CONTENT_TYPE_GAME
, "Game" },
837 static const struct drm_prop_enum_list drm_panel_orientation_enum_list
[] = {
838 { DRM_MODE_PANEL_ORIENTATION_NORMAL
, "Normal" },
839 { DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP
, "Upside Down" },
840 { DRM_MODE_PANEL_ORIENTATION_LEFT_UP
, "Left Side Up" },
841 { DRM_MODE_PANEL_ORIENTATION_RIGHT_UP
, "Right Side Up" },
844 static const struct drm_prop_enum_list drm_dvi_i_select_enum_list
[] = {
845 { DRM_MODE_SUBCONNECTOR_Automatic
, "Automatic" }, /* DVI-I and TV-out */
846 { DRM_MODE_SUBCONNECTOR_DVID
, "DVI-D" }, /* DVI-I */
847 { DRM_MODE_SUBCONNECTOR_DVIA
, "DVI-A" }, /* DVI-I */
849 DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name
, drm_dvi_i_select_enum_list
)
851 static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list
[] = {
852 { DRM_MODE_SUBCONNECTOR_Unknown
, "Unknown" }, /* DVI-I and TV-out */
853 { DRM_MODE_SUBCONNECTOR_DVID
, "DVI-D" }, /* DVI-I */
854 { DRM_MODE_SUBCONNECTOR_DVIA
, "DVI-A" }, /* DVI-I */
856 DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name
,
857 drm_dvi_i_subconnector_enum_list
)
859 static const struct drm_prop_enum_list drm_tv_select_enum_list
[] = {
860 { DRM_MODE_SUBCONNECTOR_Automatic
, "Automatic" }, /* DVI-I and TV-out */
861 { DRM_MODE_SUBCONNECTOR_Composite
, "Composite" }, /* TV-out */
862 { DRM_MODE_SUBCONNECTOR_SVIDEO
, "SVIDEO" }, /* TV-out */
863 { DRM_MODE_SUBCONNECTOR_Component
, "Component" }, /* TV-out */
864 { DRM_MODE_SUBCONNECTOR_SCART
, "SCART" }, /* TV-out */
866 DRM_ENUM_NAME_FN(drm_get_tv_select_name
, drm_tv_select_enum_list
)
868 static const struct drm_prop_enum_list drm_tv_subconnector_enum_list
[] = {
869 { DRM_MODE_SUBCONNECTOR_Unknown
, "Unknown" }, /* DVI-I and TV-out */
870 { DRM_MODE_SUBCONNECTOR_Composite
, "Composite" }, /* TV-out */
871 { DRM_MODE_SUBCONNECTOR_SVIDEO
, "SVIDEO" }, /* TV-out */
872 { DRM_MODE_SUBCONNECTOR_Component
, "Component" }, /* TV-out */
873 { DRM_MODE_SUBCONNECTOR_SCART
, "SCART" }, /* TV-out */
875 DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name
,
876 drm_tv_subconnector_enum_list
)
878 static const struct drm_prop_enum_list hdmi_colorspaces
[] = {
879 /* For Default case, driver will set the colorspace */
880 { DRM_MODE_COLORIMETRY_DEFAULT
, "Default" },
881 /* Standard Definition Colorimetry based on CEA 861 */
882 { DRM_MODE_COLORIMETRY_SMPTE_170M_YCC
, "SMPTE_170M_YCC" },
883 { DRM_MODE_COLORIMETRY_BT709_YCC
, "BT709_YCC" },
884 /* Standard Definition Colorimetry based on IEC 61966-2-4 */
885 { DRM_MODE_COLORIMETRY_XVYCC_601
, "XVYCC_601" },
886 /* High Definition Colorimetry based on IEC 61966-2-4 */
887 { DRM_MODE_COLORIMETRY_XVYCC_709
, "XVYCC_709" },
888 /* Colorimetry based on IEC 61966-2-1/Amendment 1 */
889 { DRM_MODE_COLORIMETRY_SYCC_601
, "SYCC_601" },
890 /* Colorimetry based on IEC 61966-2-5 [33] */
891 { DRM_MODE_COLORIMETRY_OPYCC_601
, "opYCC_601" },
892 /* Colorimetry based on IEC 61966-2-5 */
893 { DRM_MODE_COLORIMETRY_OPRGB
, "opRGB" },
894 /* Colorimetry based on ITU-R BT.2020 */
895 { DRM_MODE_COLORIMETRY_BT2020_CYCC
, "BT2020_CYCC" },
896 /* Colorimetry based on ITU-R BT.2020 */
897 { DRM_MODE_COLORIMETRY_BT2020_RGB
, "BT2020_RGB" },
898 /* Colorimetry based on ITU-R BT.2020 */
899 { DRM_MODE_COLORIMETRY_BT2020_YCC
, "BT2020_YCC" },
900 /* Added as part of Additional Colorimetry Extension in 861.G */
901 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65
, "DCI-P3_RGB_D65" },
902 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER
, "DCI-P3_RGB_Theater" },
906 * As per DP 1.4a spec, 2.2.5.7.5 VSC SDP Payload for Pixel Encoding/Colorimetry
909 static const struct drm_prop_enum_list dp_colorspaces
[] = {
910 /* For Default case, driver will set the colorspace */
911 { DRM_MODE_COLORIMETRY_DEFAULT
, "Default" },
912 { DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED
, "RGB_Wide_Gamut_Fixed_Point" },
913 /* Colorimetry based on scRGB (IEC 61966-2-2) */
914 { DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT
, "RGB_Wide_Gamut_Floating_Point" },
915 /* Colorimetry based on IEC 61966-2-5 */
916 { DRM_MODE_COLORIMETRY_OPRGB
, "opRGB" },
917 /* Colorimetry based on SMPTE RP 431-2 */
918 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65
, "DCI-P3_RGB_D65" },
919 /* Colorimetry based on ITU-R BT.2020 */
920 { DRM_MODE_COLORIMETRY_BT2020_RGB
, "BT2020_RGB" },
921 { DRM_MODE_COLORIMETRY_BT601_YCC
, "BT601_YCC" },
922 { DRM_MODE_COLORIMETRY_BT709_YCC
, "BT709_YCC" },
923 /* Standard Definition Colorimetry based on IEC 61966-2-4 */
924 { DRM_MODE_COLORIMETRY_XVYCC_601
, "XVYCC_601" },
925 /* High Definition Colorimetry based on IEC 61966-2-4 */
926 { DRM_MODE_COLORIMETRY_XVYCC_709
, "XVYCC_709" },
927 /* Colorimetry based on IEC 61966-2-1/Amendment 1 */
928 { DRM_MODE_COLORIMETRY_SYCC_601
, "SYCC_601" },
929 /* Colorimetry based on IEC 61966-2-5 [33] */
930 { DRM_MODE_COLORIMETRY_OPYCC_601
, "opYCC_601" },
931 /* Colorimetry based on ITU-R BT.2020 */
932 { DRM_MODE_COLORIMETRY_BT2020_CYCC
, "BT2020_CYCC" },
933 /* Colorimetry based on ITU-R BT.2020 */
934 { DRM_MODE_COLORIMETRY_BT2020_YCC
, "BT2020_YCC" },
938 * DOC: standard connector properties
940 * DRM connectors have a few standardized properties:
943 * Blob property which contains the current EDID read from the sink. This
944 * is useful to parse sink identification information like vendor, model
945 * and serial. Drivers should update this property by calling
946 * drm_connector_update_edid_property(), usually after having parsed
947 * the EDID using drm_add_edid_modes(). Userspace cannot change this
950 * Legacy property for setting the power state of the connector. For atomic
951 * drivers this is only provided for backwards compatibility with existing
952 * drivers, it remaps to controlling the "ACTIVE" property on the CRTC the
953 * connector is linked to. Drivers should never set this property directly,
954 * it is handled by the DRM core by calling the &drm_connector_funcs.dpms
955 * callback. For atomic drivers the remapping to the "ACTIVE" property is
956 * implemented in the DRM core. This is the only standard connector
957 * property that userspace can change.
959 * Note that this property cannot be set through the MODE_ATOMIC ioctl,
960 * userspace must use "ACTIVE" on the CRTC instead.
964 * For userspace also running on legacy drivers the "DPMS" semantics are a
965 * lot more complicated. First, userspace cannot rely on the "DPMS" value
966 * returned by the GETCONNECTOR actually reflecting reality, because many
967 * drivers fail to update it. For atomic drivers this is taken care of in
968 * drm_atomic_helper_update_legacy_modeset_state().
970 * The second issue is that the DPMS state is only well-defined when the
971 * connector is connected to a CRTC. In atomic the DRM core enforces that
972 * "ACTIVE" is off in such a case, no such checks exists for "DPMS".
974 * Finally, when enabling an output using the legacy SETCONFIG ioctl then
975 * "DPMS" is forced to ON. But see above, that might not be reflected in
976 * the software value on legacy drivers.
978 * Summarizing: Only set "DPMS" when the connector is known to be enabled,
979 * assume that a successful SETCONFIG call also sets "DPMS" to on, and
980 * never read back the value of "DPMS" because it can be incorrect.
982 * Connector path property to identify how this sink is physically
983 * connected. Used by DP MST. This should be set by calling
984 * drm_connector_set_path_property(), in the case of DP MST with the
985 * path property the MST manager created. Userspace cannot change this
988 * Connector tile group property to indicate how a set of DRM connector
989 * compose together into one logical screen. This is used by both high-res
990 * external screens (often only using a single cable, but exposing multiple
991 * DP MST sinks), or high-res integrated panels (like dual-link DSI) which
992 * are not gen-locked. Note that for tiled panels which are genlocked, like
993 * dual-link LVDS or dual-link DSI, the driver should try to not expose the
994 * tiling and virtualize both &drm_crtc and &drm_plane if needed. Drivers
995 * should update this value using drm_connector_set_tile_property().
996 * Userspace cannot change this property.
998 * Connector link-status property to indicate the status of link. The
999 * default value of link-status is "GOOD". If something fails during or
1000 * after modeset, the kernel driver may set this to "BAD" and issue a
1001 * hotplug uevent. Drivers should update this value using
1002 * drm_connector_set_link_status_property().
1004 * Indicates the output should be ignored for purposes of displaying a
1005 * standard desktop environment or console. This is most likely because
1006 * the output device is not rectilinear.
1007 * Content Protection:
1008 * This property is used by userspace to request the kernel protect future
1009 * content communicated over the link. When requested, kernel will apply
1010 * the appropriate means of protection (most often HDCP), and use the
1011 * property to tell userspace the protection is active.
1013 * Drivers can set this up by calling
1014 * drm_connector_attach_content_protection_property() on initialization.
1016 * The value of this property can be one of the following:
1018 * DRM_MODE_CONTENT_PROTECTION_UNDESIRED = 0
1019 * The link is not protected, content is transmitted in the clear.
1020 * DRM_MODE_CONTENT_PROTECTION_DESIRED = 1
1021 * Userspace has requested content protection, but the link is not
1022 * currently protected. When in this state, kernel should enable
1023 * Content Protection as soon as possible.
1024 * DRM_MODE_CONTENT_PROTECTION_ENABLED = 2
1025 * Userspace has requested content protection, and the link is
1026 * protected. Only the driver can set the property to this value.
1027 * If userspace attempts to set to ENABLED, kernel will return
1032 * - DESIRED state should be preserved until userspace de-asserts it by
1033 * setting the property to UNDESIRED. This means ENABLED should only
1034 * transition to UNDESIRED when the user explicitly requests it.
1035 * - If the state is DESIRED, kernel should attempt to re-authenticate the
1036 * link whenever possible. This includes across disable/enable, dpms,
1037 * hotplug, downstream device changes, link status failures, etc..
1038 * - Kernel sends uevent with the connector id and property id through
1039 * @drm_hdcp_update_content_protection, upon below kernel triggered
1042 * - DESIRED -> ENABLED (authentication success)
1043 * - ENABLED -> DESIRED (termination of authentication)
1044 * - Please note no uevents for userspace triggered property state changes,
1045 * which can't fail such as
1047 * - DESIRED/ENABLED -> UNDESIRED
1048 * - UNDESIRED -> DESIRED
1049 * - Userspace is responsible for polling the property or listen to uevents
1050 * to determine when the value transitions from ENABLED to DESIRED.
1051 * This signifies the link is no longer protected and userspace should
1052 * take appropriate action (whatever that might be).
1054 * HDCP Content Type:
1055 * This Enum property is used by the userspace to declare the content type
1056 * of the display stream, to kernel. Here display stream stands for any
1057 * display content that userspace intended to display through HDCP
1060 * Content Type of a stream is decided by the owner of the stream, as
1061 * "HDCP Type0" or "HDCP Type1".
1063 * The value of the property can be one of the below:
1064 * - "HDCP Type0": DRM_MODE_HDCP_CONTENT_TYPE0 = 0
1065 * - "HDCP Type1": DRM_MODE_HDCP_CONTENT_TYPE1 = 1
1067 * When kernel starts the HDCP authentication (see "Content Protection"
1068 * for details), it uses the content type in "HDCP Content Type"
1069 * for performing the HDCP authentication with the display sink.
1071 * Please note in HDCP spec versions, a link can be authenticated with
1072 * HDCP 2.2 for Content Type 0/Content Type 1. Where as a link can be
1073 * authenticated with HDCP1.4 only for Content Type 0(though it is implicit
1074 * in nature. As there is no reference for Content Type in HDCP1.4).
1076 * HDCP2.2 authentication protocol itself takes the "Content Type" as a
1077 * parameter, which is a input for the DP HDCP2.2 encryption algo.
1079 * In case of Type 0 content protection request, kernel driver can choose
1080 * either of HDCP spec versions 1.4 and 2.2. When HDCP2.2 is used for
1081 * "HDCP Type 0", a HDCP 2.2 capable repeater in the downstream can send
1082 * that content to a HDCP 1.4 authenticated HDCP sink (Type0 link).
1083 * But if the content is classified as "HDCP Type 1", above mentioned
1084 * HDCP 2.2 repeater wont send the content to the HDCP sink as it can't
1085 * authenticate the HDCP1.4 capable sink for "HDCP Type 1".
1087 * Please note userspace can be ignorant of the HDCP versions used by the
1088 * kernel driver to achieve the "HDCP Content Type".
1090 * At current scenario, classifying a content as Type 1 ensures that the
1091 * content will be displayed only through the HDCP2.2 encrypted link.
1093 * Note that the HDCP Content Type property is introduced at HDCP 2.2, and
1094 * defaults to type 0. It is only exposed by drivers supporting HDCP 2.2
1095 * (hence supporting Type 0 and Type 1). Based on how next versions of
1096 * HDCP specs are defined content Type could be used for higher versions
1099 * If content type is changed when "Content Protection" is not UNDESIRED,
1100 * then kernel will disable the HDCP and re-enable with new type in the
1101 * same atomic commit. And when "Content Protection" is ENABLED, it means
1102 * that link is HDCP authenticated and encrypted, for the transmission of
1103 * the Type of stream mentioned at "HDCP Content Type".
1105 * HDR_OUTPUT_METADATA:
1106 * Connector property to enable userspace to send HDR Metadata to
1107 * driver. This metadata is based on the composition and blending
1108 * policies decided by user, taking into account the hardware and
1109 * sink capabilities. The driver gets this metadata and creates a
1110 * Dynamic Range and Mastering Infoframe (DRM) in case of HDMI,
1111 * SDP packet (Non-audio INFOFRAME SDP v1.3) for DP. This is then
1112 * sent to sink. This notifies the sink of the upcoming frame's Color
1113 * Encoding and Luminance parameters.
1115 * Userspace first need to detect the HDR capabilities of sink by
1116 * reading and parsing the EDID. Details of HDR metadata for HDMI
1117 * are added in CTA 861.G spec. For DP , its defined in VESA DP
1118 * Standard v1.4. It needs to then get the metadata information
1119 * of the video/game/app content which are encoded in HDR (basically
1120 * using HDR transfer functions). With this information it needs to
1121 * decide on a blending policy and compose the relevant
1122 * layers/overlays into a common format. Once this blending is done,
1123 * userspace will be aware of the metadata of the composed frame to
1124 * be send to sink. It then uses this property to communicate this
1125 * metadata to driver which then make a Infoframe packet and sends
1126 * to sink based on the type of encoder connected.
1128 * Userspace will be responsible to do Tone mapping operation in case:
1129 * - Some layers are HDR and others are SDR
1130 * - HDR layers luminance is not same as sink
1132 * It will even need to do colorspace conversion and get all layers
1133 * to one common colorspace for blending. It can use either GL, Media
1134 * or display engine to get this done based on the capabilties of the
1135 * associated hardware.
1137 * Driver expects metadata to be put in &struct hdr_output_metadata
1138 * structure from userspace. This is received as blob and stored in
1139 * &drm_connector_state.hdr_output_metadata. It parses EDID and saves the
1140 * sink metadata in &struct hdr_sink_metadata, as
1141 * &drm_connector.hdr_sink_metadata. Driver uses
1142 * drm_hdmi_infoframe_set_hdr_metadata() helper to set the HDR metadata,
1143 * hdmi_drm_infoframe_pack() to pack the infoframe as per spec, in case of
1147 * This range property is used by userspace to limit the bit depth. When
1148 * used the driver would limit the bpc in accordance with the valid range
1149 * supported by the hardware and sink. Drivers to use the function
1150 * drm_connector_attach_max_bpc_property() to create and attach the
1151 * property to the connector during initialization.
1153 * Connectors also have one standardized atomic property:
1156 * Mode object ID of the &drm_crtc this connector should be connected to.
1158 * Connectors for LCD panels may also have one standardized property:
1160 * panel orientation:
1161 * On some devices the LCD panel is mounted in the casing in such a way
1162 * that the up/top side of the panel does not match with the top side of
1163 * the device. Userspace can use this property to check for this.
1164 * Note that input coordinates from touchscreens (input devices with
1165 * INPUT_PROP_DIRECT) will still map 1:1 to the actual LCD panel
1166 * coordinates, so if userspace rotates the picture to adjust for
1167 * the orientation it must also apply the same transformation to the
1168 * touchscreen input coordinates. This property is initialized by calling
1169 * drm_connector_set_panel_orientation() or
1170 * drm_connector_set_panel_orientation_with_quirk()
1173 * This property defines how a non-native mode is upscaled to the native
1174 * mode of an LCD panel:
1177 * No upscaling happens, scaling is left to the panel. Not all
1178 * drivers expose this mode.
1180 * The output is upscaled to the full resolution of the panel,
1181 * ignoring the aspect ratio.
1183 * No upscaling happens, the output is centered within the native
1184 * resolution the panel.
1186 * The output is upscaled to maximize either the width or height
1187 * while retaining the aspect ratio.
1189 * This property should be set up by calling
1190 * drm_connector_attach_scaling_mode_property(). Note that drivers
1191 * can also expose this property to external outputs, in which case they
1192 * must support "None", which should be the default (since external screens
1193 * have a built-in scaler).
1196 int drm_connector_create_standard_properties(struct drm_device
*dev
)
1198 struct drm_property
*prop
;
1200 prop
= drm_property_create(dev
, DRM_MODE_PROP_BLOB
|
1201 DRM_MODE_PROP_IMMUTABLE
,
1205 dev
->mode_config
.edid_property
= prop
;
1207 prop
= drm_property_create_enum(dev
, 0,
1208 "DPMS", drm_dpms_enum_list
,
1209 ARRAY_SIZE(drm_dpms_enum_list
));
1212 dev
->mode_config
.dpms_property
= prop
;
1214 prop
= drm_property_create(dev
,
1215 DRM_MODE_PROP_BLOB
|
1216 DRM_MODE_PROP_IMMUTABLE
,
1220 dev
->mode_config
.path_property
= prop
;
1222 prop
= drm_property_create(dev
,
1223 DRM_MODE_PROP_BLOB
|
1224 DRM_MODE_PROP_IMMUTABLE
,
1228 dev
->mode_config
.tile_property
= prop
;
1230 prop
= drm_property_create_enum(dev
, 0, "link-status",
1231 drm_link_status_enum_list
,
1232 ARRAY_SIZE(drm_link_status_enum_list
));
1235 dev
->mode_config
.link_status_property
= prop
;
1237 prop
= drm_property_create_bool(dev
, DRM_MODE_PROP_IMMUTABLE
, "non-desktop");
1240 dev
->mode_config
.non_desktop_property
= prop
;
1242 prop
= drm_property_create(dev
, DRM_MODE_PROP_BLOB
,
1243 "HDR_OUTPUT_METADATA", 0);
1246 dev
->mode_config
.hdr_output_metadata_property
= prop
;
1252 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1255 * Called by a driver the first time a DVI-I connector is made.
1257 int drm_mode_create_dvi_i_properties(struct drm_device
*dev
)
1259 struct drm_property
*dvi_i_selector
;
1260 struct drm_property
*dvi_i_subconnector
;
1262 if (dev
->mode_config
.dvi_i_select_subconnector_property
)
1266 drm_property_create_enum(dev
, 0,
1267 "select subconnector",
1268 drm_dvi_i_select_enum_list
,
1269 ARRAY_SIZE(drm_dvi_i_select_enum_list
));
1270 dev
->mode_config
.dvi_i_select_subconnector_property
= dvi_i_selector
;
1272 dvi_i_subconnector
= drm_property_create_enum(dev
, DRM_MODE_PROP_IMMUTABLE
,
1274 drm_dvi_i_subconnector_enum_list
,
1275 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list
));
1276 dev
->mode_config
.dvi_i_subconnector_property
= dvi_i_subconnector
;
1280 EXPORT_SYMBOL(drm_mode_create_dvi_i_properties
);
1283 * DOC: HDMI connector properties
1285 * content type (HDMI specific):
1286 * Indicates content type setting to be used in HDMI infoframes to indicate
1287 * content type for the external device, so that it adjusts its display
1288 * settings accordingly.
1290 * The value of this property can be one of the following:
1293 * Content type is unknown
1295 * Content type is graphics
1297 * Content type is photo
1299 * Content type is cinema
1301 * Content type is game
1303 * Drivers can set up this property by calling
1304 * drm_connector_attach_content_type_property(). Decoding to
1305 * infoframe values is done through drm_hdmi_avi_infoframe_content_type().
1309 * drm_connector_attach_content_type_property - attach content-type property
1310 * @connector: connector to attach content type property on.
1312 * Called by a driver the first time a HDMI connector is made.
1314 int drm_connector_attach_content_type_property(struct drm_connector
*connector
)
1316 if (!drm_mode_create_content_type_property(connector
->dev
))
1317 drm_object_attach_property(&connector
->base
,
1318 connector
->dev
->mode_config
.content_type_property
,
1319 DRM_MODE_CONTENT_TYPE_NO_DATA
);
1322 EXPORT_SYMBOL(drm_connector_attach_content_type_property
);
1326 * drm_hdmi_avi_infoframe_content_type() - fill the HDMI AVI infoframe
1327 * content type information, based
1328 * on correspondent DRM property.
1329 * @frame: HDMI AVI infoframe
1330 * @conn_state: DRM display connector state
1333 void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe
*frame
,
1334 const struct drm_connector_state
*conn_state
)
1336 switch (conn_state
->content_type
) {
1337 case DRM_MODE_CONTENT_TYPE_GRAPHICS
:
1338 frame
->content_type
= HDMI_CONTENT_TYPE_GRAPHICS
;
1340 case DRM_MODE_CONTENT_TYPE_CINEMA
:
1341 frame
->content_type
= HDMI_CONTENT_TYPE_CINEMA
;
1343 case DRM_MODE_CONTENT_TYPE_GAME
:
1344 frame
->content_type
= HDMI_CONTENT_TYPE_GAME
;
1346 case DRM_MODE_CONTENT_TYPE_PHOTO
:
1347 frame
->content_type
= HDMI_CONTENT_TYPE_PHOTO
;
1350 /* Graphics is the default(0) */
1351 frame
->content_type
= HDMI_CONTENT_TYPE_GRAPHICS
;
1354 frame
->itc
= conn_state
->content_type
!= DRM_MODE_CONTENT_TYPE_NO_DATA
;
1356 EXPORT_SYMBOL(drm_hdmi_avi_infoframe_content_type
);
1359 * drm_mode_attach_tv_margin_properties - attach TV connector margin properties
1360 * @connector: DRM connector
1362 * Called by a driver when it needs to attach TV margin props to a connector.
1363 * Typically used on SDTV and HDMI connectors.
1365 void drm_connector_attach_tv_margin_properties(struct drm_connector
*connector
)
1367 struct drm_device
*dev
= connector
->dev
;
1369 drm_object_attach_property(&connector
->base
,
1370 dev
->mode_config
.tv_left_margin_property
,
1372 drm_object_attach_property(&connector
->base
,
1373 dev
->mode_config
.tv_right_margin_property
,
1375 drm_object_attach_property(&connector
->base
,
1376 dev
->mode_config
.tv_top_margin_property
,
1378 drm_object_attach_property(&connector
->base
,
1379 dev
->mode_config
.tv_bottom_margin_property
,
1382 EXPORT_SYMBOL(drm_connector_attach_tv_margin_properties
);
1385 * drm_mode_create_tv_margin_properties - create TV connector margin properties
1388 * Called by a driver's HDMI connector initialization routine, this function
1389 * creates the TV margin properties for a given device. No need to call this
1390 * function for an SDTV connector, it's already called from
1391 * drm_mode_create_tv_properties().
1393 int drm_mode_create_tv_margin_properties(struct drm_device
*dev
)
1395 if (dev
->mode_config
.tv_left_margin_property
)
1398 dev
->mode_config
.tv_left_margin_property
=
1399 drm_property_create_range(dev
, 0, "left margin", 0, 100);
1400 if (!dev
->mode_config
.tv_left_margin_property
)
1403 dev
->mode_config
.tv_right_margin_property
=
1404 drm_property_create_range(dev
, 0, "right margin", 0, 100);
1405 if (!dev
->mode_config
.tv_right_margin_property
)
1408 dev
->mode_config
.tv_top_margin_property
=
1409 drm_property_create_range(dev
, 0, "top margin", 0, 100);
1410 if (!dev
->mode_config
.tv_top_margin_property
)
1413 dev
->mode_config
.tv_bottom_margin_property
=
1414 drm_property_create_range(dev
, 0, "bottom margin", 0, 100);
1415 if (!dev
->mode_config
.tv_bottom_margin_property
)
1420 EXPORT_SYMBOL(drm_mode_create_tv_margin_properties
);
1423 * drm_mode_create_tv_properties - create TV specific connector properties
1425 * @num_modes: number of different TV formats (modes) supported
1426 * @modes: array of pointers to strings containing name of each format
1428 * Called by a driver's TV initialization routine, this function creates
1429 * the TV specific connector properties for a given device. Caller is
1430 * responsible for allocating a list of format names and passing them to
1433 int drm_mode_create_tv_properties(struct drm_device
*dev
,
1434 unsigned int num_modes
,
1435 const char * const modes
[])
1437 struct drm_property
*tv_selector
;
1438 struct drm_property
*tv_subconnector
;
1441 if (dev
->mode_config
.tv_select_subconnector_property
)
1445 * Basic connector properties
1447 tv_selector
= drm_property_create_enum(dev
, 0,
1448 "select subconnector",
1449 drm_tv_select_enum_list
,
1450 ARRAY_SIZE(drm_tv_select_enum_list
));
1454 dev
->mode_config
.tv_select_subconnector_property
= tv_selector
;
1457 drm_property_create_enum(dev
, DRM_MODE_PROP_IMMUTABLE
,
1459 drm_tv_subconnector_enum_list
,
1460 ARRAY_SIZE(drm_tv_subconnector_enum_list
));
1461 if (!tv_subconnector
)
1463 dev
->mode_config
.tv_subconnector_property
= tv_subconnector
;
1466 * Other, TV specific properties: margins & TV modes.
1468 if (drm_mode_create_tv_margin_properties(dev
))
1471 dev
->mode_config
.tv_mode_property
=
1472 drm_property_create(dev
, DRM_MODE_PROP_ENUM
,
1474 if (!dev
->mode_config
.tv_mode_property
)
1477 for (i
= 0; i
< num_modes
; i
++)
1478 drm_property_add_enum(dev
->mode_config
.tv_mode_property
,
1481 dev
->mode_config
.tv_brightness_property
=
1482 drm_property_create_range(dev
, 0, "brightness", 0, 100);
1483 if (!dev
->mode_config
.tv_brightness_property
)
1486 dev
->mode_config
.tv_contrast_property
=
1487 drm_property_create_range(dev
, 0, "contrast", 0, 100);
1488 if (!dev
->mode_config
.tv_contrast_property
)
1491 dev
->mode_config
.tv_flicker_reduction_property
=
1492 drm_property_create_range(dev
, 0, "flicker reduction", 0, 100);
1493 if (!dev
->mode_config
.tv_flicker_reduction_property
)
1496 dev
->mode_config
.tv_overscan_property
=
1497 drm_property_create_range(dev
, 0, "overscan", 0, 100);
1498 if (!dev
->mode_config
.tv_overscan_property
)
1501 dev
->mode_config
.tv_saturation_property
=
1502 drm_property_create_range(dev
, 0, "saturation", 0, 100);
1503 if (!dev
->mode_config
.tv_saturation_property
)
1506 dev
->mode_config
.tv_hue_property
=
1507 drm_property_create_range(dev
, 0, "hue", 0, 100);
1508 if (!dev
->mode_config
.tv_hue_property
)
1515 EXPORT_SYMBOL(drm_mode_create_tv_properties
);
1518 * drm_mode_create_scaling_mode_property - create scaling mode property
1521 * Called by a driver the first time it's needed, must be attached to desired
1524 * Atomic drivers should use drm_connector_attach_scaling_mode_property()
1525 * instead to correctly assign &drm_connector_state.picture_aspect_ratio
1526 * in the atomic state.
1528 int drm_mode_create_scaling_mode_property(struct drm_device
*dev
)
1530 struct drm_property
*scaling_mode
;
1532 if (dev
->mode_config
.scaling_mode_property
)
1536 drm_property_create_enum(dev
, 0, "scaling mode",
1537 drm_scaling_mode_enum_list
,
1538 ARRAY_SIZE(drm_scaling_mode_enum_list
));
1540 dev
->mode_config
.scaling_mode_property
= scaling_mode
;
1544 EXPORT_SYMBOL(drm_mode_create_scaling_mode_property
);
1547 * DOC: Variable refresh properties
1549 * Variable refresh rate capable displays can dynamically adjust their
1550 * refresh rate by extending the duration of their vertical front porch
1551 * until page flip or timeout occurs. This can reduce or remove stuttering
1552 * and latency in scenarios where the page flip does not align with the
1555 * An example scenario would be an application flipping at a constant rate
1556 * of 48Hz on a 60Hz display. The page flip will frequently miss the vblank
1557 * interval and the same contents will be displayed twice. This can be
1558 * observed as stuttering for content with motion.
1560 * If variable refresh rate was active on a display that supported a
1561 * variable refresh range from 35Hz to 60Hz no stuttering would be observable
1562 * for the example scenario. The minimum supported variable refresh rate of
1563 * 35Hz is below the page flip frequency and the vertical front porch can
1564 * be extended until the page flip occurs. The vblank interval will be
1565 * directly aligned to the page flip rate.
1567 * Not all userspace content is suitable for use with variable refresh rate.
1568 * Large and frequent changes in vertical front porch duration may worsen
1569 * perceived stuttering for input sensitive applications.
1571 * Panel brightness will also vary with vertical front porch duration. Some
1572 * panels may have noticeable differences in brightness between the minimum
1573 * vertical front porch duration and the maximum vertical front porch duration.
1574 * Large and frequent changes in vertical front porch duration may produce
1575 * observable flickering for such panels.
1577 * Userspace control for variable refresh rate is supported via properties
1578 * on the &drm_connector and &drm_crtc objects.
1581 * Optional &drm_connector boolean property that drivers should attach
1582 * with drm_connector_attach_vrr_capable_property() on connectors that
1583 * could support variable refresh rates. Drivers should update the
1584 * property value by calling drm_connector_set_vrr_capable_property().
1586 * Absence of the property should indicate absence of support.
1589 * Default &drm_crtc boolean property that notifies the driver that the
1590 * content on the CRTC is suitable for variable refresh rate presentation.
1591 * The driver will take this property as a hint to enable variable
1592 * refresh rate support if the receiver supports it, ie. if the
1593 * "vrr_capable" property is true on the &drm_connector object. The
1594 * vertical front porch duration will be extended until page-flip or
1595 * timeout when enabled.
1597 * The minimum vertical front porch duration is defined as the vertical
1598 * front porch duration for the current mode.
1600 * The maximum vertical front porch duration is greater than or equal to
1601 * the minimum vertical front porch duration. The duration is derived
1602 * from the minimum supported variable refresh rate for the connector.
1604 * The driver may place further restrictions within these minimum
1605 * and maximum bounds.
1609 * drm_connector_attach_vrr_capable_property - creates the
1610 * vrr_capable property
1611 * @connector: connector to create the vrr_capable property on.
1613 * This is used by atomic drivers to add support for querying
1614 * variable refresh rate capability for a connector.
1617 * Zero on success, negative errono on failure.
1619 int drm_connector_attach_vrr_capable_property(
1620 struct drm_connector
*connector
)
1622 struct drm_device
*dev
= connector
->dev
;
1623 struct drm_property
*prop
;
1625 if (!connector
->vrr_capable_property
) {
1626 prop
= drm_property_create_bool(dev
, DRM_MODE_PROP_IMMUTABLE
,
1631 connector
->vrr_capable_property
= prop
;
1632 drm_object_attach_property(&connector
->base
, prop
, 0);
1637 EXPORT_SYMBOL(drm_connector_attach_vrr_capable_property
);
1640 * drm_connector_attach_scaling_mode_property - attach atomic scaling mode property
1641 * @connector: connector to attach scaling mode property on.
1642 * @scaling_mode_mask: or'ed mask of BIT(%DRM_MODE_SCALE_\*).
1644 * This is used to add support for scaling mode to atomic drivers.
1645 * The scaling mode will be set to &drm_connector_state.picture_aspect_ratio
1646 * and can be used from &drm_connector_helper_funcs->atomic_check for validation.
1648 * This is the atomic version of drm_mode_create_scaling_mode_property().
1651 * Zero on success, negative errno on failure.
1653 int drm_connector_attach_scaling_mode_property(struct drm_connector
*connector
,
1654 u32 scaling_mode_mask
)
1656 struct drm_device
*dev
= connector
->dev
;
1657 struct drm_property
*scaling_mode_property
;
1659 const unsigned valid_scaling_mode_mask
=
1660 (1U << ARRAY_SIZE(drm_scaling_mode_enum_list
)) - 1;
1662 if (WARN_ON(hweight32(scaling_mode_mask
) < 2 ||
1663 scaling_mode_mask
& ~valid_scaling_mode_mask
))
1666 scaling_mode_property
=
1667 drm_property_create(dev
, DRM_MODE_PROP_ENUM
, "scaling mode",
1668 hweight32(scaling_mode_mask
));
1670 if (!scaling_mode_property
)
1673 for (i
= 0; i
< ARRAY_SIZE(drm_scaling_mode_enum_list
); i
++) {
1676 if (!(BIT(i
) & scaling_mode_mask
))
1679 ret
= drm_property_add_enum(scaling_mode_property
,
1680 drm_scaling_mode_enum_list
[i
].type
,
1681 drm_scaling_mode_enum_list
[i
].name
);
1684 drm_property_destroy(dev
, scaling_mode_property
);
1690 drm_object_attach_property(&connector
->base
,
1691 scaling_mode_property
, 0);
1693 connector
->scaling_mode_property
= scaling_mode_property
;
1697 EXPORT_SYMBOL(drm_connector_attach_scaling_mode_property
);
1700 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1703 * Called by a driver the first time it's needed, must be attached to desired
1707 * Zero on success, negative errno on failure.
1709 int drm_mode_create_aspect_ratio_property(struct drm_device
*dev
)
1711 if (dev
->mode_config
.aspect_ratio_property
)
1714 dev
->mode_config
.aspect_ratio_property
=
1715 drm_property_create_enum(dev
, 0, "aspect ratio",
1716 drm_aspect_ratio_enum_list
,
1717 ARRAY_SIZE(drm_aspect_ratio_enum_list
));
1719 if (dev
->mode_config
.aspect_ratio_property
== NULL
)
1724 EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property
);
1727 * DOC: standard connector properties
1730 * This property helps select a suitable colorspace based on the sink
1731 * capability. Modern sink devices support wider gamut like BT2020.
1732 * This helps switch to BT2020 mode if the BT2020 encoded video stream
1733 * is being played by the user, same for any other colorspace. Thereby
1734 * giving a good visual experience to users.
1736 * The expectation from userspace is that it should parse the EDID
1737 * and get supported colorspaces. Use this property and switch to the
1738 * one supported. Sink supported colorspaces should be retrieved by
1739 * userspace from EDID and driver will not explicitly expose them.
1741 * Basically the expectation from userspace is:
1742 * - Set up CRTC DEGAMMA/CTM/GAMMA to convert to some sink
1744 * - Set this new property to let the sink know what it
1745 * converted the CRTC output to.
1746 * - This property is just to inform sink what colorspace
1747 * source is trying to drive.
1749 * Because between HDMI and DP have different colorspaces,
1750 * drm_mode_create_hdmi_colorspace_property() is used for HDMI connector and
1751 * drm_mode_create_dp_colorspace_property() is used for DP connector.
1755 * drm_mode_create_hdmi_colorspace_property - create hdmi colorspace property
1756 * @connector: connector to create the Colorspace property on.
1758 * Called by a driver the first time it's needed, must be attached to desired
1762 * Zero on success, negative errono on failure.
1764 int drm_mode_create_hdmi_colorspace_property(struct drm_connector
*connector
)
1766 struct drm_device
*dev
= connector
->dev
;
1768 if (connector
->colorspace_property
)
1771 connector
->colorspace_property
=
1772 drm_property_create_enum(dev
, DRM_MODE_PROP_ENUM
, "Colorspace",
1774 ARRAY_SIZE(hdmi_colorspaces
));
1776 if (!connector
->colorspace_property
)
1781 EXPORT_SYMBOL(drm_mode_create_hdmi_colorspace_property
);
1784 * drm_mode_create_dp_colorspace_property - create dp colorspace property
1785 * @connector: connector to create the Colorspace property on.
1787 * Called by a driver the first time it's needed, must be attached to desired
1791 * Zero on success, negative errono on failure.
1793 int drm_mode_create_dp_colorspace_property(struct drm_connector
*connector
)
1795 struct drm_device
*dev
= connector
->dev
;
1797 if (connector
->colorspace_property
)
1800 connector
->colorspace_property
=
1801 drm_property_create_enum(dev
, DRM_MODE_PROP_ENUM
, "Colorspace",
1803 ARRAY_SIZE(dp_colorspaces
));
1805 if (!connector
->colorspace_property
)
1810 EXPORT_SYMBOL(drm_mode_create_dp_colorspace_property
);
1813 * drm_mode_create_content_type_property - create content type property
1816 * Called by a driver the first time it's needed, must be attached to desired
1820 * Zero on success, negative errno on failure.
1822 int drm_mode_create_content_type_property(struct drm_device
*dev
)
1824 if (dev
->mode_config
.content_type_property
)
1827 dev
->mode_config
.content_type_property
=
1828 drm_property_create_enum(dev
, 0, "content type",
1829 drm_content_type_enum_list
,
1830 ARRAY_SIZE(drm_content_type_enum_list
));
1832 if (dev
->mode_config
.content_type_property
== NULL
)
1837 EXPORT_SYMBOL(drm_mode_create_content_type_property
);
1840 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1843 * Create the the suggested x/y offset property for connectors.
1845 int drm_mode_create_suggested_offset_properties(struct drm_device
*dev
)
1847 if (dev
->mode_config
.suggested_x_property
&& dev
->mode_config
.suggested_y_property
)
1850 dev
->mode_config
.suggested_x_property
=
1851 drm_property_create_range(dev
, DRM_MODE_PROP_IMMUTABLE
, "suggested X", 0, 0xffffffff);
1853 dev
->mode_config
.suggested_y_property
=
1854 drm_property_create_range(dev
, DRM_MODE_PROP_IMMUTABLE
, "suggested Y", 0, 0xffffffff);
1856 if (dev
->mode_config
.suggested_x_property
== NULL
||
1857 dev
->mode_config
.suggested_y_property
== NULL
)
1861 EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties
);
1864 * drm_connector_set_path_property - set tile property on connector
1865 * @connector: connector to set property on.
1866 * @path: path to use for property; must not be NULL.
1868 * This creates a property to expose to userspace to specify a
1869 * connector path. This is mainly used for DisplayPort MST where
1870 * connectors have a topology and we want to allow userspace to give
1871 * them more meaningful names.
1874 * Zero on success, negative errno on failure.
1876 int drm_connector_set_path_property(struct drm_connector
*connector
,
1879 struct drm_device
*dev
= connector
->dev
;
1882 ret
= drm_property_replace_global_blob(dev
,
1883 &connector
->path_blob_ptr
,
1887 dev
->mode_config
.path_property
);
1890 EXPORT_SYMBOL(drm_connector_set_path_property
);
1893 * drm_connector_set_tile_property - set tile property on connector
1894 * @connector: connector to set property on.
1896 * This looks up the tile information for a connector, and creates a
1897 * property for userspace to parse if it exists. The property is of
1898 * the form of 8 integers using ':' as a separator.
1899 * This is used for dual port tiled displays with DisplayPort SST
1900 * or DisplayPort MST connectors.
1903 * Zero on success, errno on failure.
1905 int drm_connector_set_tile_property(struct drm_connector
*connector
)
1907 struct drm_device
*dev
= connector
->dev
;
1911 if (!connector
->has_tile
) {
1912 ret
= drm_property_replace_global_blob(dev
,
1913 &connector
->tile_blob_ptr
,
1917 dev
->mode_config
.tile_property
);
1921 snprintf(tile
, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
1922 connector
->tile_group
->id
, connector
->tile_is_single_monitor
,
1923 connector
->num_h_tile
, connector
->num_v_tile
,
1924 connector
->tile_h_loc
, connector
->tile_v_loc
,
1925 connector
->tile_h_size
, connector
->tile_v_size
);
1927 ret
= drm_property_replace_global_blob(dev
,
1928 &connector
->tile_blob_ptr
,
1932 dev
->mode_config
.tile_property
);
1935 EXPORT_SYMBOL(drm_connector_set_tile_property
);
1938 * drm_connector_update_edid_property - update the edid property of a connector
1939 * @connector: drm connector
1940 * @edid: new value of the edid property
1942 * This function creates a new blob modeset object and assigns its id to the
1943 * connector's edid property.
1944 * Since we also parse tile information from EDID's displayID block, we also
1945 * set the connector's tile property here. See drm_connector_set_tile_property()
1949 * Zero on success, negative errno on failure.
1951 int drm_connector_update_edid_property(struct drm_connector
*connector
,
1952 const struct edid
*edid
)
1954 struct drm_device
*dev
= connector
->dev
;
1958 /* ignore requests to set edid when overridden */
1959 if (connector
->override_edid
)
1963 size
= EDID_LENGTH
* (1 + edid
->extensions
);
1965 /* Set the display info, using edid if available, otherwise
1966 * reseting the values to defaults. This duplicates the work
1967 * done in drm_add_edid_modes, but that function is not
1968 * consistently called before this one in all drivers and the
1969 * computation is cheap enough that it seems better to
1970 * duplicate it rather than attempt to ensure some arbitrary
1971 * ordering of calls.
1974 drm_add_display_info(connector
, edid
);
1976 drm_reset_display_info(connector
);
1978 drm_update_tile_info(connector
, edid
);
1980 drm_object_property_set_value(&connector
->base
,
1981 dev
->mode_config
.non_desktop_property
,
1982 connector
->display_info
.non_desktop
);
1984 ret
= drm_property_replace_global_blob(dev
,
1985 &connector
->edid_blob_ptr
,
1989 dev
->mode_config
.edid_property
);
1992 return drm_connector_set_tile_property(connector
);
1994 EXPORT_SYMBOL(drm_connector_update_edid_property
);
1997 * drm_connector_set_link_status_property - Set link status property of a connector
1998 * @connector: drm connector
1999 * @link_status: new value of link status property (0: Good, 1: Bad)
2001 * In usual working scenario, this link status property will always be set to
2002 * "GOOD". If something fails during or after a mode set, the kernel driver
2003 * may set this link status property to "BAD". The caller then needs to send a
2004 * hotplug uevent for userspace to re-check the valid modes through
2005 * GET_CONNECTOR_IOCTL and retry modeset.
2007 * Note: Drivers cannot rely on userspace to support this property and
2008 * issue a modeset. As such, they may choose to handle issues (like
2009 * re-training a link) without userspace's intervention.
2011 * The reason for adding this property is to handle link training failures, but
2012 * it is not limited to DP or link training. For example, if we implement
2013 * asynchronous setcrtc, this property can be used to report any failures in that.
2015 void drm_connector_set_link_status_property(struct drm_connector
*connector
,
2016 uint64_t link_status
)
2018 struct drm_device
*dev
= connector
->dev
;
2020 drm_modeset_lock(&dev
->mode_config
.connection_mutex
, NULL
);
2021 connector
->state
->link_status
= link_status
;
2022 drm_modeset_unlock(&dev
->mode_config
.connection_mutex
);
2024 EXPORT_SYMBOL(drm_connector_set_link_status_property
);
2027 * drm_connector_attach_max_bpc_property - attach "max bpc" property
2028 * @connector: connector to attach max bpc property on.
2029 * @min: The minimum bit depth supported by the connector.
2030 * @max: The maximum bit depth supported by the connector.
2032 * This is used to add support for limiting the bit depth on a connector.
2035 * Zero on success, negative errno on failure.
2037 int drm_connector_attach_max_bpc_property(struct drm_connector
*connector
,
2040 struct drm_device
*dev
= connector
->dev
;
2041 struct drm_property
*prop
;
2043 prop
= connector
->max_bpc_property
;
2045 prop
= drm_property_create_range(dev
, 0, "max bpc", min
, max
);
2049 connector
->max_bpc_property
= prop
;
2052 drm_object_attach_property(&connector
->base
, prop
, max
);
2053 connector
->state
->max_requested_bpc
= max
;
2054 connector
->state
->max_bpc
= max
;
2058 EXPORT_SYMBOL(drm_connector_attach_max_bpc_property
);
2061 * drm_connector_set_vrr_capable_property - sets the variable refresh rate
2062 * capable property for a connector
2063 * @connector: drm connector
2064 * @capable: True if the connector is variable refresh rate capable
2066 * Should be used by atomic drivers to update the indicated support for
2067 * variable refresh rate over a connector.
2069 void drm_connector_set_vrr_capable_property(
2070 struct drm_connector
*connector
, bool capable
)
2072 drm_object_property_set_value(&connector
->base
,
2073 connector
->vrr_capable_property
,
2076 EXPORT_SYMBOL(drm_connector_set_vrr_capable_property
);
2079 * drm_connector_set_panel_orientation - sets the connecter's panel_orientation
2080 * @connector: connector for which to set the panel-orientation property.
2081 * @panel_orientation: drm_panel_orientation value to set
2083 * This function sets the connector's panel_orientation and attaches
2084 * a "panel orientation" property to the connector.
2086 * Calling this function on a connector where the panel_orientation has
2087 * already been set is a no-op (e.g. the orientation has been overridden with
2088 * a kernel commandline option).
2090 * It is allowed to call this function with a panel_orientation of
2091 * DRM_MODE_PANEL_ORIENTATION_UNKNOWN, in which case it is a no-op.
2094 * Zero on success, negative errno on failure.
2096 int drm_connector_set_panel_orientation(
2097 struct drm_connector
*connector
,
2098 enum drm_panel_orientation panel_orientation
)
2100 struct drm_device
*dev
= connector
->dev
;
2101 struct drm_display_info
*info
= &connector
->display_info
;
2102 struct drm_property
*prop
;
2105 if (info
->panel_orientation
!= DRM_MODE_PANEL_ORIENTATION_UNKNOWN
)
2108 /* Don't attach the property if the orientation is unknown */
2109 if (panel_orientation
== DRM_MODE_PANEL_ORIENTATION_UNKNOWN
)
2112 info
->panel_orientation
= panel_orientation
;
2114 prop
= dev
->mode_config
.panel_orientation_property
;
2116 prop
= drm_property_create_enum(dev
, DRM_MODE_PROP_IMMUTABLE
,
2117 "panel orientation",
2118 drm_panel_orientation_enum_list
,
2119 ARRAY_SIZE(drm_panel_orientation_enum_list
));
2123 dev
->mode_config
.panel_orientation_property
= prop
;
2126 drm_object_attach_property(&connector
->base
, prop
,
2127 info
->panel_orientation
);
2130 EXPORT_SYMBOL(drm_connector_set_panel_orientation
);
2133 * drm_connector_set_panel_orientation_with_quirk -
2134 * set the connecter's panel_orientation after checking for quirks
2135 * @connector: connector for which to init the panel-orientation property.
2136 * @panel_orientation: drm_panel_orientation value to set
2137 * @width: width in pixels of the panel, used for panel quirk detection
2138 * @height: height in pixels of the panel, used for panel quirk detection
2140 * Like drm_connector_set_panel_orientation(), but with a check for platform
2141 * specific (e.g. DMI based) quirks overriding the passed in panel_orientation.
2144 * Zero on success, negative errno on failure.
2146 int drm_connector_set_panel_orientation_with_quirk(
2147 struct drm_connector
*connector
,
2148 enum drm_panel_orientation panel_orientation
,
2149 int width
, int height
)
2151 int orientation_quirk
;
2153 orientation_quirk
= drm_get_panel_orientation_quirk(width
, height
);
2154 if (orientation_quirk
!= DRM_MODE_PANEL_ORIENTATION_UNKNOWN
)
2155 panel_orientation
= orientation_quirk
;
2157 return drm_connector_set_panel_orientation(connector
,
2160 EXPORT_SYMBOL(drm_connector_set_panel_orientation_with_quirk
);
2162 int drm_connector_set_obj_prop(struct drm_mode_object
*obj
,
2163 struct drm_property
*property
,
2167 struct drm_connector
*connector
= obj_to_connector(obj
);
2169 /* Do DPMS ourselves */
2170 if (property
== connector
->dev
->mode_config
.dpms_property
) {
2171 ret
= (*connector
->funcs
->dpms
)(connector
, (int)value
);
2172 } else if (connector
->funcs
->set_property
)
2173 ret
= connector
->funcs
->set_property(connector
, property
, value
);
2176 drm_object_property_set_value(&connector
->base
, property
, value
);
2180 int drm_connector_property_set_ioctl(struct drm_device
*dev
,
2181 void *data
, struct drm_file
*file_priv
)
2183 struct drm_mode_connector_set_property
*conn_set_prop
= data
;
2184 struct drm_mode_obj_set_property obj_set_prop
= {
2185 .value
= conn_set_prop
->value
,
2186 .prop_id
= conn_set_prop
->prop_id
,
2187 .obj_id
= conn_set_prop
->connector_id
,
2188 .obj_type
= DRM_MODE_OBJECT_CONNECTOR
2191 /* It does all the locking and checking we need */
2192 return drm_mode_obj_set_property_ioctl(dev
, &obj_set_prop
, file_priv
);
2195 static struct drm_encoder
*drm_connector_get_encoder(struct drm_connector
*connector
)
2197 /* For atomic drivers only state objects are synchronously updated and
2198 * protected by modeset locks, so check those first. */
2199 if (connector
->state
)
2200 return connector
->state
->best_encoder
;
2201 return connector
->encoder
;
2205 drm_mode_expose_to_userspace(const struct drm_display_mode
*mode
,
2206 const struct list_head
*export_list
,
2207 const struct drm_file
*file_priv
)
2210 * If user-space hasn't configured the driver to expose the stereo 3D
2211 * modes, don't expose them.
2213 if (!file_priv
->stereo_allowed
&& drm_mode_is_stereo(mode
))
2216 * If user-space hasn't configured the driver to expose the modes
2217 * with aspect-ratio, don't expose them. However if such a mode
2218 * is unique, let it be exposed, but reset the aspect-ratio flags
2219 * while preparing the list of user-modes.
2221 if (!file_priv
->aspect_ratio_allowed
) {
2222 struct drm_display_mode
*mode_itr
;
2224 list_for_each_entry(mode_itr
, export_list
, export_head
)
2225 if (drm_mode_match(mode_itr
, mode
,
2226 DRM_MODE_MATCH_TIMINGS
|
2227 DRM_MODE_MATCH_CLOCK
|
2228 DRM_MODE_MATCH_FLAGS
|
2229 DRM_MODE_MATCH_3D_FLAGS
))
2236 int drm_mode_getconnector(struct drm_device
*dev
, void *data
,
2237 struct drm_file
*file_priv
)
2239 struct drm_mode_get_connector
*out_resp
= data
;
2240 struct drm_connector
*connector
;
2241 struct drm_encoder
*encoder
;
2242 struct drm_display_mode
*mode
;
2244 int encoders_count
= 0;
2247 struct drm_mode_modeinfo u_mode
;
2248 struct drm_mode_modeinfo __user
*mode_ptr
;
2249 uint32_t __user
*encoder_ptr
;
2250 LIST_HEAD(export_list
);
2252 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
2255 memset(&u_mode
, 0, sizeof(struct drm_mode_modeinfo
));
2257 connector
= drm_connector_lookup(dev
, file_priv
, out_resp
->connector_id
);
2261 encoders_count
= hweight32(connector
->possible_encoders
);
2263 if ((out_resp
->count_encoders
>= encoders_count
) && encoders_count
) {
2265 encoder_ptr
= (uint32_t __user
*)(unsigned long)(out_resp
->encoders_ptr
);
2267 drm_connector_for_each_possible_encoder(connector
, encoder
) {
2268 if (put_user(encoder
->base
.id
, encoder_ptr
+ copied
)) {
2275 out_resp
->count_encoders
= encoders_count
;
2277 out_resp
->connector_id
= connector
->base
.id
;
2278 out_resp
->connector_type
= connector
->connector_type
;
2279 out_resp
->connector_type_id
= connector
->connector_type_id
;
2281 mutex_lock(&dev
->mode_config
.mutex
);
2282 if (out_resp
->count_modes
== 0) {
2283 connector
->funcs
->fill_modes(connector
,
2284 dev
->mode_config
.max_width
,
2285 dev
->mode_config
.max_height
);
2288 out_resp
->mm_width
= connector
->display_info
.width_mm
;
2289 out_resp
->mm_height
= connector
->display_info
.height_mm
;
2290 out_resp
->subpixel
= connector
->display_info
.subpixel_order
;
2291 out_resp
->connection
= connector
->status
;
2293 /* delayed so we get modes regardless of pre-fill_modes state */
2294 list_for_each_entry(mode
, &connector
->modes
, head
)
2295 if (drm_mode_expose_to_userspace(mode
, &export_list
,
2297 list_add_tail(&mode
->export_head
, &export_list
);
2302 * This ioctl is called twice, once to determine how much space is
2303 * needed, and the 2nd time to fill it.
2304 * The modes that need to be exposed to the user are maintained in the
2305 * 'export_list'. When the ioctl is called first time to determine the,
2306 * space, the export_list gets filled, to find the no.of modes. In the
2307 * 2nd time, the user modes are filled, one by one from the export_list.
2309 if ((out_resp
->count_modes
>= mode_count
) && mode_count
) {
2311 mode_ptr
= (struct drm_mode_modeinfo __user
*)(unsigned long)out_resp
->modes_ptr
;
2312 list_for_each_entry(mode
, &export_list
, export_head
) {
2313 drm_mode_convert_to_umode(&u_mode
, mode
);
2315 * Reset aspect ratio flags of user-mode, if modes with
2316 * aspect-ratio are not supported.
2318 if (!file_priv
->aspect_ratio_allowed
)
2319 u_mode
.flags
&= ~DRM_MODE_FLAG_PIC_AR_MASK
;
2320 if (copy_to_user(mode_ptr
+ copied
,
2321 &u_mode
, sizeof(u_mode
))) {
2323 mutex_unlock(&dev
->mode_config
.mutex
);
2330 out_resp
->count_modes
= mode_count
;
2331 mutex_unlock(&dev
->mode_config
.mutex
);
2333 drm_modeset_lock(&dev
->mode_config
.connection_mutex
, NULL
);
2334 encoder
= drm_connector_get_encoder(connector
);
2336 out_resp
->encoder_id
= encoder
->base
.id
;
2338 out_resp
->encoder_id
= 0;
2340 /* Only grab properties after probing, to make sure EDID and other
2341 * properties reflect the latest status. */
2342 ret
= drm_mode_object_get_properties(&connector
->base
, file_priv
->atomic
,
2343 (uint32_t __user
*)(unsigned long)(out_resp
->props_ptr
),
2344 (uint64_t __user
*)(unsigned long)(out_resp
->prop_values_ptr
),
2345 &out_resp
->count_props
);
2346 drm_modeset_unlock(&dev
->mode_config
.connection_mutex
);
2349 drm_connector_put(connector
);
2358 * Tile groups are used to represent tiled monitors with a unique integer
2359 * identifier. Tiled monitors using DisplayID v1.3 have a unique 8-byte handle,
2360 * we store this in a tile group, so we have a common identifier for all tiles
2361 * in a monitor group. The property is called "TILE". Drivers can manage tile
2362 * groups using drm_mode_create_tile_group(), drm_mode_put_tile_group() and
2363 * drm_mode_get_tile_group(). But this is only needed for internal panels where
2364 * the tile group information is exposed through a non-standard way.
2367 static void drm_tile_group_free(struct kref
*kref
)
2369 struct drm_tile_group
*tg
= container_of(kref
, struct drm_tile_group
, refcount
);
2370 struct drm_device
*dev
= tg
->dev
;
2371 mutex_lock(&dev
->mode_config
.idr_mutex
);
2372 idr_remove(&dev
->mode_config
.tile_idr
, tg
->id
);
2373 mutex_unlock(&dev
->mode_config
.idr_mutex
);
2378 * drm_mode_put_tile_group - drop a reference to a tile group.
2380 * @tg: tile group to drop reference to.
2382 * drop reference to tile group and free if 0.
2384 void drm_mode_put_tile_group(struct drm_device
*dev
,
2385 struct drm_tile_group
*tg
)
2387 kref_put(&tg
->refcount
, drm_tile_group_free
);
2389 EXPORT_SYMBOL(drm_mode_put_tile_group
);
2392 * drm_mode_get_tile_group - get a reference to an existing tile group
2394 * @topology: 8-bytes unique per monitor.
2396 * Use the unique bytes to get a reference to an existing tile group.
2399 * tile group or NULL if not found.
2401 struct drm_tile_group
*drm_mode_get_tile_group(struct drm_device
*dev
,
2402 const char topology
[8])
2404 struct drm_tile_group
*tg
;
2406 mutex_lock(&dev
->mode_config
.idr_mutex
);
2407 idr_for_each_entry(&dev
->mode_config
.tile_idr
, tg
, id
) {
2408 if (!memcmp(tg
->group_data
, topology
, 8)) {
2409 if (!kref_get_unless_zero(&tg
->refcount
))
2411 mutex_unlock(&dev
->mode_config
.idr_mutex
);
2415 mutex_unlock(&dev
->mode_config
.idr_mutex
);
2418 EXPORT_SYMBOL(drm_mode_get_tile_group
);
2421 * drm_mode_create_tile_group - create a tile group from a displayid description
2423 * @topology: 8-bytes unique per monitor.
2425 * Create a tile group for the unique monitor, and get a unique
2426 * identifier for the tile group.
2429 * new tile group or NULL.
2431 struct drm_tile_group
*drm_mode_create_tile_group(struct drm_device
*dev
,
2432 const char topology
[8])
2434 struct drm_tile_group
*tg
;
2437 tg
= kzalloc(sizeof(*tg
), GFP_KERNEL
);
2441 kref_init(&tg
->refcount
);
2442 memcpy(tg
->group_data
, topology
, 8);
2445 mutex_lock(&dev
->mode_config
.idr_mutex
);
2446 ret
= idr_alloc(&dev
->mode_config
.tile_idr
, tg
, 1, 0, GFP_KERNEL
);
2454 mutex_unlock(&dev
->mode_config
.idr_mutex
);
2457 EXPORT_SYMBOL(drm_mode_create_tile_group
);