Loading...
1/*
2 * Copyright (c) 2016 Intel Corporation
3 *
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.
13 *
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
20 * OF THIS SOFTWARE.
21 */
22
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>
31
32#include <linux/uaccess.h>
33
34#include "drm_crtc_internal.h"
35#include "drm_internal.h"
36
37/**
38 * DOC: overview
39 *
40 * In DRM connectors are the general abstraction for display sinks, and include
41 * also 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().
46 *
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().
53 *
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
58 * attached encoder.
59 *
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().
65 */
66
67struct drm_conn_prop_enum_list {
68 int type;
69 const char *name;
70 struct ida ida;
71};
72
73/*
74 * Connector and encoder types.
75 */
76static 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" },
97};
98
99void drm_connector_ida_init(void)
100{
101 int i;
102
103 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
104 ida_init(&drm_connector_enum_list[i].ida);
105}
106
107void drm_connector_ida_destroy(void)
108{
109 int i;
110
111 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
112 ida_destroy(&drm_connector_enum_list[i].ida);
113}
114
115/**
116 * drm_get_connector_type_name - return a string for connector type
117 * @type: The connector type (DRM_MODE_CONNECTOR_*)
118 *
119 * Returns: the name of the connector type, or NULL if the type is not valid.
120 */
121const char *drm_get_connector_type_name(unsigned int type)
122{
123 if (type < ARRAY_SIZE(drm_connector_enum_list))
124 return drm_connector_enum_list[type].name;
125
126 return NULL;
127}
128EXPORT_SYMBOL(drm_get_connector_type_name);
129
130/**
131 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
132 * @connector: connector to query
133 *
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
138 * setup.
139 */
140static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
141{
142 struct drm_cmdline_mode *mode = &connector->cmdline_mode;
143 char *option = NULL;
144
145 if (fb_get_options(connector->name, &option))
146 return;
147
148 if (!drm_mode_parse_command_line_for_connector(option,
149 connector,
150 mode))
151 return;
152
153 if (mode->force) {
154 DRM_INFO("forcing %s connector %s\n", connector->name,
155 drm_get_connector_force_name(mode->force));
156 connector->force = mode->force;
157 }
158
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);
164 }
165
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" : "");
173}
174
175static void drm_connector_free(struct kref *kref)
176{
177 struct drm_connector *connector =
178 container_of(kref, struct drm_connector, base.refcount);
179 struct drm_device *dev = connector->dev;
180
181 drm_mode_object_unregister(dev, &connector->base);
182 connector->funcs->destroy(connector);
183}
184
185void drm_connector_free_work_fn(struct work_struct *work)
186{
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;
191 unsigned long flags;
192 struct llist_node *freed;
193
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);
197
198 llist_for_each_entry_safe(connector, n, freed, free_node) {
199 drm_mode_object_unregister(dev, &connector->base);
200 connector->funcs->destroy(connector);
201 }
202}
203
204/**
205 * drm_connector_init - Init a preallocated connector
206 * @dev: DRM device
207 * @connector: the connector to init
208 * @funcs: callbacks for this connector
209 * @connector_type: user visible type of the connector
210 *
211 * Initialises a preallocated connector. Connectors should be
212 * subclassed as part of driver connector objects.
213 *
214 * Returns:
215 * Zero on success, error code on failure.
216 */
217int drm_connector_init(struct drm_device *dev,
218 struct drm_connector *connector,
219 const struct drm_connector_funcs *funcs,
220 int connector_type)
221{
222 struct drm_mode_config *config = &dev->mode_config;
223 int ret;
224 struct ida *connector_ida =
225 &drm_connector_enum_list[connector_type].ida;
226
227 WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
228 (!funcs->atomic_destroy_state ||
229 !funcs->atomic_duplicate_state));
230
231 ret = __drm_mode_object_add(dev, &connector->base,
232 DRM_MODE_OBJECT_CONNECTOR,
233 false, drm_connector_free);
234 if (ret)
235 return ret;
236
237 connector->base.properties = &connector->properties;
238 connector->dev = dev;
239 connector->funcs = funcs;
240
241 /* connector index is used with 32bit bitmasks */
242 ret = ida_simple_get(&config->connector_ida, 0, 32, GFP_KERNEL);
243 if (ret < 0) {
244 DRM_DEBUG_KMS("Failed to allocate %s connector index: %d\n",
245 drm_connector_enum_list[connector_type].name,
246 ret);
247 goto out_put;
248 }
249 connector->index = ret;
250 ret = 0;
251
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;
257 goto out_put_id;
258 }
259 connector->name =
260 kasprintf(GFP_KERNEL, "%s-%d",
261 drm_connector_enum_list[connector_type].name,
262 connector->connector_type_id);
263 if (!connector->name) {
264 ret = -ENOMEM;
265 goto out_put_type_id;
266 }
267
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->epoch_counter = 0;
273 connector->tile_blob_ptr = NULL;
274 connector->status = connector_status_unknown;
275 connector->display_info.panel_orientation =
276 DRM_MODE_PANEL_ORIENTATION_UNKNOWN;
277
278 drm_connector_get_cmdline_mode(connector);
279
280 /* We should add connectors at the end to avoid upsetting the connector
281 * index too much. */
282 spin_lock_irq(&config->connector_list_lock);
283 list_add_tail(&connector->head, &config->connector_list);
284 config->num_connector++;
285 spin_unlock_irq(&config->connector_list_lock);
286
287 if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL &&
288 connector_type != DRM_MODE_CONNECTOR_WRITEBACK)
289 drm_connector_attach_edid_property(connector);
290
291 drm_object_attach_property(&connector->base,
292 config->dpms_property, 0);
293
294 drm_object_attach_property(&connector->base,
295 config->link_status_property,
296 0);
297
298 drm_object_attach_property(&connector->base,
299 config->non_desktop_property,
300 0);
301 drm_object_attach_property(&connector->base,
302 config->tile_property,
303 0);
304
305 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
306 drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
307 }
308
309 connector->debugfs_entry = NULL;
310out_put_type_id:
311 if (ret)
312 ida_simple_remove(connector_ida, connector->connector_type_id);
313out_put_id:
314 if (ret)
315 ida_simple_remove(&config->connector_ida, connector->index);
316out_put:
317 if (ret)
318 drm_mode_object_unregister(dev, &connector->base);
319
320 return ret;
321}
322EXPORT_SYMBOL(drm_connector_init);
323
324/**
325 * drm_connector_init_with_ddc - Init a preallocated connector
326 * @dev: DRM device
327 * @connector: the connector to init
328 * @funcs: callbacks for this connector
329 * @connector_type: user visible type of the connector
330 * @ddc: pointer to the associated ddc adapter
331 *
332 * Initialises a preallocated connector. Connectors should be
333 * subclassed as part of driver connector objects.
334 *
335 * Ensures that the ddc field of the connector is correctly set.
336 *
337 * Returns:
338 * Zero on success, error code on failure.
339 */
340int drm_connector_init_with_ddc(struct drm_device *dev,
341 struct drm_connector *connector,
342 const struct drm_connector_funcs *funcs,
343 int connector_type,
344 struct i2c_adapter *ddc)
345{
346 int ret;
347
348 ret = drm_connector_init(dev, connector, funcs, connector_type);
349 if (ret)
350 return ret;
351
352 /* provide ddc symlink in sysfs */
353 connector->ddc = ddc;
354
355 return ret;
356}
357EXPORT_SYMBOL(drm_connector_init_with_ddc);
358
359/**
360 * drm_connector_attach_edid_property - attach edid property.
361 * @connector: the connector
362 *
363 * Some connector types like DRM_MODE_CONNECTOR_VIRTUAL do not get a
364 * edid property attached by default. This function can be used to
365 * explicitly enable the edid property in these cases.
366 */
367void drm_connector_attach_edid_property(struct drm_connector *connector)
368{
369 struct drm_mode_config *config = &connector->dev->mode_config;
370
371 drm_object_attach_property(&connector->base,
372 config->edid_property,
373 0);
374}
375EXPORT_SYMBOL(drm_connector_attach_edid_property);
376
377/**
378 * drm_connector_attach_encoder - attach a connector to an encoder
379 * @connector: connector to attach
380 * @encoder: encoder to attach @connector to
381 *
382 * This function links up a connector to an encoder. Note that the routing
383 * restrictions between encoders and crtcs are exposed to userspace through the
384 * possible_clones and possible_crtcs bitmasks.
385 *
386 * Returns:
387 * Zero on success, negative errno on failure.
388 */
389int drm_connector_attach_encoder(struct drm_connector *connector,
390 struct drm_encoder *encoder)
391{
392 /*
393 * In the past, drivers have attempted to model the static association
394 * of connector to encoder in simple connector/encoder devices using a
395 * direct assignment of connector->encoder = encoder. This connection
396 * is a logical one and the responsibility of the core, so drivers are
397 * expected not to mess with this.
398 *
399 * Note that the error return should've been enough here, but a large
400 * majority of drivers ignores the return value, so add in a big WARN
401 * to get people's attention.
402 */
403 if (WARN_ON(connector->encoder))
404 return -EINVAL;
405
406 connector->possible_encoders |= drm_encoder_mask(encoder);
407
408 return 0;
409}
410EXPORT_SYMBOL(drm_connector_attach_encoder);
411
412/**
413 * drm_connector_has_possible_encoder - check if the connector and encoder are
414 * associated with each other
415 * @connector: the connector
416 * @encoder: the encoder
417 *
418 * Returns:
419 * True if @encoder is one of the possible encoders for @connector.
420 */
421bool drm_connector_has_possible_encoder(struct drm_connector *connector,
422 struct drm_encoder *encoder)
423{
424 return connector->possible_encoders & drm_encoder_mask(encoder);
425}
426EXPORT_SYMBOL(drm_connector_has_possible_encoder);
427
428static void drm_mode_remove(struct drm_connector *connector,
429 struct drm_display_mode *mode)
430{
431 list_del(&mode->head);
432 drm_mode_destroy(connector->dev, mode);
433}
434
435/**
436 * drm_connector_cleanup - cleans up an initialised connector
437 * @connector: connector to cleanup
438 *
439 * Cleans up the connector but doesn't free the object.
440 */
441void drm_connector_cleanup(struct drm_connector *connector)
442{
443 struct drm_device *dev = connector->dev;
444 struct drm_display_mode *mode, *t;
445
446 /* The connector should have been removed from userspace long before
447 * it is finally destroyed.
448 */
449 if (WARN_ON(connector->registration_state ==
450 DRM_CONNECTOR_REGISTERED))
451 drm_connector_unregister(connector);
452
453 if (connector->tile_group) {
454 drm_mode_put_tile_group(dev, connector->tile_group);
455 connector->tile_group = NULL;
456 }
457
458 list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
459 drm_mode_remove(connector, mode);
460
461 list_for_each_entry_safe(mode, t, &connector->modes, head)
462 drm_mode_remove(connector, mode);
463
464 ida_simple_remove(&drm_connector_enum_list[connector->connector_type].ida,
465 connector->connector_type_id);
466
467 ida_simple_remove(&dev->mode_config.connector_ida,
468 connector->index);
469
470 kfree(connector->display_info.bus_formats);
471 drm_mode_object_unregister(dev, &connector->base);
472 kfree(connector->name);
473 connector->name = NULL;
474 spin_lock_irq(&dev->mode_config.connector_list_lock);
475 list_del(&connector->head);
476 dev->mode_config.num_connector--;
477 spin_unlock_irq(&dev->mode_config.connector_list_lock);
478
479 WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
480 if (connector->state && connector->funcs->atomic_destroy_state)
481 connector->funcs->atomic_destroy_state(connector,
482 connector->state);
483
484 mutex_destroy(&connector->mutex);
485
486 memset(connector, 0, sizeof(*connector));
487}
488EXPORT_SYMBOL(drm_connector_cleanup);
489
490/**
491 * drm_connector_register - register a connector
492 * @connector: the connector to register
493 *
494 * Register userspace interfaces for a connector. Only call this for connectors
495 * which can be hotplugged after drm_dev_register() has been called already,
496 * e.g. DP MST connectors. All other connectors will be registered automatically
497 * when calling drm_dev_register().
498 *
499 * Returns:
500 * Zero on success, error code on failure.
501 */
502int drm_connector_register(struct drm_connector *connector)
503{
504 int ret = 0;
505
506 if (!connector->dev->registered)
507 return 0;
508
509 mutex_lock(&connector->mutex);
510 if (connector->registration_state != DRM_CONNECTOR_INITIALIZING)
511 goto unlock;
512
513 ret = drm_sysfs_connector_add(connector);
514 if (ret)
515 goto unlock;
516
517 drm_debugfs_connector_add(connector);
518
519 if (connector->funcs->late_register) {
520 ret = connector->funcs->late_register(connector);
521 if (ret)
522 goto err_debugfs;
523 }
524
525 drm_mode_object_register(connector->dev, &connector->base);
526
527 connector->registration_state = DRM_CONNECTOR_REGISTERED;
528
529 /* Let userspace know we have a new connector */
530 drm_sysfs_hotplug_event(connector->dev);
531
532 goto unlock;
533
534err_debugfs:
535 drm_debugfs_connector_remove(connector);
536 drm_sysfs_connector_remove(connector);
537unlock:
538 mutex_unlock(&connector->mutex);
539 return ret;
540}
541EXPORT_SYMBOL(drm_connector_register);
542
543/**
544 * drm_connector_unregister - unregister a connector
545 * @connector: the connector to unregister
546 *
547 * Unregister userspace interfaces for a connector. Only call this for
548 * connectors which have registered explicitly by calling drm_dev_register(),
549 * since connectors are unregistered automatically when drm_dev_unregister() is
550 * called.
551 */
552void drm_connector_unregister(struct drm_connector *connector)
553{
554 mutex_lock(&connector->mutex);
555 if (connector->registration_state != DRM_CONNECTOR_REGISTERED) {
556 mutex_unlock(&connector->mutex);
557 return;
558 }
559
560 if (connector->funcs->early_unregister)
561 connector->funcs->early_unregister(connector);
562
563 drm_sysfs_connector_remove(connector);
564 drm_debugfs_connector_remove(connector);
565
566 connector->registration_state = DRM_CONNECTOR_UNREGISTERED;
567 mutex_unlock(&connector->mutex);
568}
569EXPORT_SYMBOL(drm_connector_unregister);
570
571void drm_connector_unregister_all(struct drm_device *dev)
572{
573 struct drm_connector *connector;
574 struct drm_connector_list_iter conn_iter;
575
576 drm_connector_list_iter_begin(dev, &conn_iter);
577 drm_for_each_connector_iter(connector, &conn_iter)
578 drm_connector_unregister(connector);
579 drm_connector_list_iter_end(&conn_iter);
580}
581
582int drm_connector_register_all(struct drm_device *dev)
583{
584 struct drm_connector *connector;
585 struct drm_connector_list_iter conn_iter;
586 int ret = 0;
587
588 drm_connector_list_iter_begin(dev, &conn_iter);
589 drm_for_each_connector_iter(connector, &conn_iter) {
590 ret = drm_connector_register(connector);
591 if (ret)
592 break;
593 }
594 drm_connector_list_iter_end(&conn_iter);
595
596 if (ret)
597 drm_connector_unregister_all(dev);
598 return ret;
599}
600
601/**
602 * drm_get_connector_status_name - return a string for connector status
603 * @status: connector status to compute name of
604 *
605 * In contrast to the other drm_get_*_name functions this one here returns a
606 * const pointer and hence is threadsafe.
607 */
608const char *drm_get_connector_status_name(enum drm_connector_status status)
609{
610 if (status == connector_status_connected)
611 return "connected";
612 else if (status == connector_status_disconnected)
613 return "disconnected";
614 else
615 return "unknown";
616}
617EXPORT_SYMBOL(drm_get_connector_status_name);
618
619/**
620 * drm_get_connector_force_name - return a string for connector force
621 * @force: connector force to get name of
622 *
623 * Returns: const pointer to name.
624 */
625const char *drm_get_connector_force_name(enum drm_connector_force force)
626{
627 switch (force) {
628 case DRM_FORCE_UNSPECIFIED:
629 return "unspecified";
630 case DRM_FORCE_OFF:
631 return "off";
632 case DRM_FORCE_ON:
633 return "on";
634 case DRM_FORCE_ON_DIGITAL:
635 return "digital";
636 default:
637 return "unknown";
638 }
639}
640
641#ifdef CONFIG_LOCKDEP
642static struct lockdep_map connector_list_iter_dep_map = {
643 .name = "drm_connector_list_iter"
644};
645#endif
646
647/**
648 * drm_connector_list_iter_begin - initialize a connector_list iterator
649 * @dev: DRM device
650 * @iter: connector_list iterator
651 *
652 * Sets @iter up to walk the &drm_mode_config.connector_list of @dev. @iter
653 * must always be cleaned up again by calling drm_connector_list_iter_end().
654 * Iteration itself happens using drm_connector_list_iter_next() or
655 * drm_for_each_connector_iter().
656 */
657void drm_connector_list_iter_begin(struct drm_device *dev,
658 struct drm_connector_list_iter *iter)
659{
660 iter->dev = dev;
661 iter->conn = NULL;
662 lock_acquire_shared_recursive(&connector_list_iter_dep_map, 0, 1, NULL, _RET_IP_);
663}
664EXPORT_SYMBOL(drm_connector_list_iter_begin);
665
666/*
667 * Extra-safe connector put function that works in any context. Should only be
668 * used from the connector_iter functions, where we never really expect to
669 * actually release the connector when dropping our final reference.
670 */
671static void
672__drm_connector_put_safe(struct drm_connector *conn)
673{
674 struct drm_mode_config *config = &conn->dev->mode_config;
675
676 lockdep_assert_held(&config->connector_list_lock);
677
678 if (!refcount_dec_and_test(&conn->base.refcount.refcount))
679 return;
680
681 llist_add(&conn->free_node, &config->connector_free_list);
682 schedule_work(&config->connector_free_work);
683}
684
685/**
686 * drm_connector_list_iter_next - return next connector
687 * @iter: connector_list iterator
688 *
689 * Returns the next connector for @iter, or NULL when the list walk has
690 * completed.
691 */
692struct drm_connector *
693drm_connector_list_iter_next(struct drm_connector_list_iter *iter)
694{
695 struct drm_connector *old_conn = iter->conn;
696 struct drm_mode_config *config = &iter->dev->mode_config;
697 struct list_head *lhead;
698 unsigned long flags;
699
700 spin_lock_irqsave(&config->connector_list_lock, flags);
701 lhead = old_conn ? &old_conn->head : &config->connector_list;
702
703 do {
704 if (lhead->next == &config->connector_list) {
705 iter->conn = NULL;
706 break;
707 }
708
709 lhead = lhead->next;
710 iter->conn = list_entry(lhead, struct drm_connector, head);
711
712 /* loop until it's not a zombie connector */
713 } while (!kref_get_unless_zero(&iter->conn->base.refcount));
714
715 if (old_conn)
716 __drm_connector_put_safe(old_conn);
717 spin_unlock_irqrestore(&config->connector_list_lock, flags);
718
719 return iter->conn;
720}
721EXPORT_SYMBOL(drm_connector_list_iter_next);
722
723/**
724 * drm_connector_list_iter_end - tear down a connector_list iterator
725 * @iter: connector_list iterator
726 *
727 * Tears down @iter and releases any resources (like &drm_connector references)
728 * acquired while walking the list. This must always be called, both when the
729 * iteration completes fully or when it was aborted without walking the entire
730 * list.
731 */
732void drm_connector_list_iter_end(struct drm_connector_list_iter *iter)
733{
734 struct drm_mode_config *config = &iter->dev->mode_config;
735 unsigned long flags;
736
737 iter->dev = NULL;
738 if (iter->conn) {
739 spin_lock_irqsave(&config->connector_list_lock, flags);
740 __drm_connector_put_safe(iter->conn);
741 spin_unlock_irqrestore(&config->connector_list_lock, flags);
742 }
743 lock_release(&connector_list_iter_dep_map, _RET_IP_);
744}
745EXPORT_SYMBOL(drm_connector_list_iter_end);
746
747static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
748 { SubPixelUnknown, "Unknown" },
749 { SubPixelHorizontalRGB, "Horizontal RGB" },
750 { SubPixelHorizontalBGR, "Horizontal BGR" },
751 { SubPixelVerticalRGB, "Vertical RGB" },
752 { SubPixelVerticalBGR, "Vertical BGR" },
753 { SubPixelNone, "None" },
754};
755
756/**
757 * drm_get_subpixel_order_name - return a string for a given subpixel enum
758 * @order: enum of subpixel_order
759 *
760 * Note you could abuse this and return something out of bounds, but that
761 * would be a caller error. No unscrubbed user data should make it here.
762 */
763const char *drm_get_subpixel_order_name(enum subpixel_order order)
764{
765 return drm_subpixel_enum_list[order].name;
766}
767EXPORT_SYMBOL(drm_get_subpixel_order_name);
768
769static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
770 { DRM_MODE_DPMS_ON, "On" },
771 { DRM_MODE_DPMS_STANDBY, "Standby" },
772 { DRM_MODE_DPMS_SUSPEND, "Suspend" },
773 { DRM_MODE_DPMS_OFF, "Off" }
774};
775DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
776
777static const struct drm_prop_enum_list drm_link_status_enum_list[] = {
778 { DRM_MODE_LINK_STATUS_GOOD, "Good" },
779 { DRM_MODE_LINK_STATUS_BAD, "Bad" },
780};
781
782/**
783 * drm_display_info_set_bus_formats - set the supported bus formats
784 * @info: display info to store bus formats in
785 * @formats: array containing the supported bus formats
786 * @num_formats: the number of entries in the fmts array
787 *
788 * Store the supported bus formats in display info structure.
789 * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
790 * a full list of available formats.
791 */
792int drm_display_info_set_bus_formats(struct drm_display_info *info,
793 const u32 *formats,
794 unsigned int num_formats)
795{
796 u32 *fmts = NULL;
797
798 if (!formats && num_formats)
799 return -EINVAL;
800
801 if (formats && num_formats) {
802 fmts = kmemdup(formats, sizeof(*formats) * num_formats,
803 GFP_KERNEL);
804 if (!fmts)
805 return -ENOMEM;
806 }
807
808 kfree(info->bus_formats);
809 info->bus_formats = fmts;
810 info->num_bus_formats = num_formats;
811
812 return 0;
813}
814EXPORT_SYMBOL(drm_display_info_set_bus_formats);
815
816/* Optional connector properties. */
817static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
818 { DRM_MODE_SCALE_NONE, "None" },
819 { DRM_MODE_SCALE_FULLSCREEN, "Full" },
820 { DRM_MODE_SCALE_CENTER, "Center" },
821 { DRM_MODE_SCALE_ASPECT, "Full aspect" },
822};
823
824static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
825 { DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
826 { DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
827 { DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
828};
829
830static const struct drm_prop_enum_list drm_content_type_enum_list[] = {
831 { DRM_MODE_CONTENT_TYPE_NO_DATA, "No Data" },
832 { DRM_MODE_CONTENT_TYPE_GRAPHICS, "Graphics" },
833 { DRM_MODE_CONTENT_TYPE_PHOTO, "Photo" },
834 { DRM_MODE_CONTENT_TYPE_CINEMA, "Cinema" },
835 { DRM_MODE_CONTENT_TYPE_GAME, "Game" },
836};
837
838static const struct drm_prop_enum_list drm_panel_orientation_enum_list[] = {
839 { DRM_MODE_PANEL_ORIENTATION_NORMAL, "Normal" },
840 { DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP, "Upside Down" },
841 { DRM_MODE_PANEL_ORIENTATION_LEFT_UP, "Left Side Up" },
842 { DRM_MODE_PANEL_ORIENTATION_RIGHT_UP, "Right Side Up" },
843};
844
845static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
846 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
847 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
848 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
849};
850DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
851
852static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
853 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
854 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
855 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
856};
857DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
858 drm_dvi_i_subconnector_enum_list)
859
860static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
861 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
862 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
863 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
864 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
865 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
866};
867DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
868
869static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
870 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I and TV-out */
871 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
872 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
873 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
874 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
875};
876DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
877 drm_tv_subconnector_enum_list)
878
879static const struct drm_prop_enum_list hdmi_colorspaces[] = {
880 /* For Default case, driver will set the colorspace */
881 { DRM_MODE_COLORIMETRY_DEFAULT, "Default" },
882 /* Standard Definition Colorimetry based on CEA 861 */
883 { DRM_MODE_COLORIMETRY_SMPTE_170M_YCC, "SMPTE_170M_YCC" },
884 { DRM_MODE_COLORIMETRY_BT709_YCC, "BT709_YCC" },
885 /* Standard Definition Colorimetry based on IEC 61966-2-4 */
886 { DRM_MODE_COLORIMETRY_XVYCC_601, "XVYCC_601" },
887 /* High Definition Colorimetry based on IEC 61966-2-4 */
888 { DRM_MODE_COLORIMETRY_XVYCC_709, "XVYCC_709" },
889 /* Colorimetry based on IEC 61966-2-1/Amendment 1 */
890 { DRM_MODE_COLORIMETRY_SYCC_601, "SYCC_601" },
891 /* Colorimetry based on IEC 61966-2-5 [33] */
892 { DRM_MODE_COLORIMETRY_OPYCC_601, "opYCC_601" },
893 /* Colorimetry based on IEC 61966-2-5 */
894 { DRM_MODE_COLORIMETRY_OPRGB, "opRGB" },
895 /* Colorimetry based on ITU-R BT.2020 */
896 { DRM_MODE_COLORIMETRY_BT2020_CYCC, "BT2020_CYCC" },
897 /* Colorimetry based on ITU-R BT.2020 */
898 { DRM_MODE_COLORIMETRY_BT2020_RGB, "BT2020_RGB" },
899 /* Colorimetry based on ITU-R BT.2020 */
900 { DRM_MODE_COLORIMETRY_BT2020_YCC, "BT2020_YCC" },
901 /* Added as part of Additional Colorimetry Extension in 861.G */
902 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65, "DCI-P3_RGB_D65" },
903 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER, "DCI-P3_RGB_Theater" },
904};
905
906/*
907 * As per DP 1.4a spec, 2.2.5.7.5 VSC SDP Payload for Pixel Encoding/Colorimetry
908 * Format Table 2-120
909 */
910static const struct drm_prop_enum_list dp_colorspaces[] = {
911 /* For Default case, driver will set the colorspace */
912 { DRM_MODE_COLORIMETRY_DEFAULT, "Default" },
913 { DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED, "RGB_Wide_Gamut_Fixed_Point" },
914 /* Colorimetry based on scRGB (IEC 61966-2-2) */
915 { DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT, "RGB_Wide_Gamut_Floating_Point" },
916 /* Colorimetry based on IEC 61966-2-5 */
917 { DRM_MODE_COLORIMETRY_OPRGB, "opRGB" },
918 /* Colorimetry based on SMPTE RP 431-2 */
919 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65, "DCI-P3_RGB_D65" },
920 /* Colorimetry based on ITU-R BT.2020 */
921 { DRM_MODE_COLORIMETRY_BT2020_RGB, "BT2020_RGB" },
922 { DRM_MODE_COLORIMETRY_BT601_YCC, "BT601_YCC" },
923 { DRM_MODE_COLORIMETRY_BT709_YCC, "BT709_YCC" },
924 /* Standard Definition Colorimetry based on IEC 61966-2-4 */
925 { DRM_MODE_COLORIMETRY_XVYCC_601, "XVYCC_601" },
926 /* High Definition Colorimetry based on IEC 61966-2-4 */
927 { DRM_MODE_COLORIMETRY_XVYCC_709, "XVYCC_709" },
928 /* Colorimetry based on IEC 61966-2-1/Amendment 1 */
929 { DRM_MODE_COLORIMETRY_SYCC_601, "SYCC_601" },
930 /* Colorimetry based on IEC 61966-2-5 [33] */
931 { DRM_MODE_COLORIMETRY_OPYCC_601, "opYCC_601" },
932 /* Colorimetry based on ITU-R BT.2020 */
933 { DRM_MODE_COLORIMETRY_BT2020_CYCC, "BT2020_CYCC" },
934 /* Colorimetry based on ITU-R BT.2020 */
935 { DRM_MODE_COLORIMETRY_BT2020_YCC, "BT2020_YCC" },
936};
937
938/**
939 * DOC: standard connector properties
940 *
941 * DRM connectors have a few standardized properties:
942 *
943 * EDID:
944 * Blob property which contains the current EDID read from the sink. This
945 * is useful to parse sink identification information like vendor, model
946 * and serial. Drivers should update this property by calling
947 * drm_connector_update_edid_property(), usually after having parsed
948 * the EDID using drm_add_edid_modes(). Userspace cannot change this
949 * property.
950 * DPMS:
951 * Legacy property for setting the power state of the connector. For atomic
952 * drivers this is only provided for backwards compatibility with existing
953 * drivers, it remaps to controlling the "ACTIVE" property on the CRTC the
954 * connector is linked to. Drivers should never set this property directly,
955 * it is handled by the DRM core by calling the &drm_connector_funcs.dpms
956 * callback. For atomic drivers the remapping to the "ACTIVE" property is
957 * implemented in the DRM core.
958 *
959 * Note that this property cannot be set through the MODE_ATOMIC ioctl,
960 * userspace must use "ACTIVE" on the CRTC instead.
961 *
962 * WARNING:
963 *
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().
969 *
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".
973 *
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.
977 *
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.
981 * PATH:
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
986 * property.
987 * TILE:
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 virtualise 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.
997 * link-status:
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().
1003 *
1004 * When user-space receives the hotplug uevent and detects a "BAD"
1005 * link-status, the sink doesn't receive pixels anymore (e.g. the screen
1006 * becomes completely black). The list of available modes may have
1007 * changed. User-space is expected to pick a new mode if the current one
1008 * has disappeared and perform a new modeset with link-status set to
1009 * "GOOD" to re-enable the connector.
1010 *
1011 * If multiple connectors share the same CRTC and one of them gets a "BAD"
1012 * link-status, the other are unaffected (ie. the sinks still continue to
1013 * receive pixels).
1014 *
1015 * When user-space performs an atomic commit on a connector with a "BAD"
1016 * link-status without resetting the property to "GOOD", the sink may
1017 * still not receive pixels. When user-space performs an atomic commit
1018 * which resets the link-status property to "GOOD" without the
1019 * ALLOW_MODESET flag set, it might fail because a modeset is required.
1020 *
1021 * User-space can only change link-status to "GOOD", changing it to "BAD"
1022 * is a no-op.
1023 *
1024 * For backwards compatibility with non-atomic userspace the kernel
1025 * tries to automatically set the link-status back to "GOOD" in the
1026 * SETCRTC IOCTL. This might fail if the mode is no longer valid, similar
1027 * to how it might fail if a different screen has been connected in the
1028 * interim.
1029 * non_desktop:
1030 * Indicates the output should be ignored for purposes of displaying a
1031 * standard desktop environment or console. This is most likely because
1032 * the output device is not rectilinear.
1033 * Content Protection:
1034 * This property is used by userspace to request the kernel protect future
1035 * content communicated over the link. When requested, kernel will apply
1036 * the appropriate means of protection (most often HDCP), and use the
1037 * property to tell userspace the protection is active.
1038 *
1039 * Drivers can set this up by calling
1040 * drm_connector_attach_content_protection_property() on initialization.
1041 *
1042 * The value of this property can be one of the following:
1043 *
1044 * DRM_MODE_CONTENT_PROTECTION_UNDESIRED = 0
1045 * The link is not protected, content is transmitted in the clear.
1046 * DRM_MODE_CONTENT_PROTECTION_DESIRED = 1
1047 * Userspace has requested content protection, but the link is not
1048 * currently protected. When in this state, kernel should enable
1049 * Content Protection as soon as possible.
1050 * DRM_MODE_CONTENT_PROTECTION_ENABLED = 2
1051 * Userspace has requested content protection, and the link is
1052 * protected. Only the driver can set the property to this value.
1053 * If userspace attempts to set to ENABLED, kernel will return
1054 * -EINVAL.
1055 *
1056 * A few guidelines:
1057 *
1058 * - DESIRED state should be preserved until userspace de-asserts it by
1059 * setting the property to UNDESIRED. This means ENABLED should only
1060 * transition to UNDESIRED when the user explicitly requests it.
1061 * - If the state is DESIRED, kernel should attempt to re-authenticate the
1062 * link whenever possible. This includes across disable/enable, dpms,
1063 * hotplug, downstream device changes, link status failures, etc..
1064 * - Kernel sends uevent with the connector id and property id through
1065 * @drm_hdcp_update_content_protection, upon below kernel triggered
1066 * scenarios:
1067 *
1068 * - DESIRED -> ENABLED (authentication success)
1069 * - ENABLED -> DESIRED (termination of authentication)
1070 * - Please note no uevents for userspace triggered property state changes,
1071 * which can't fail such as
1072 *
1073 * - DESIRED/ENABLED -> UNDESIRED
1074 * - UNDESIRED -> DESIRED
1075 * - Userspace is responsible for polling the property or listen to uevents
1076 * to determine when the value transitions from ENABLED to DESIRED.
1077 * This signifies the link is no longer protected and userspace should
1078 * take appropriate action (whatever that might be).
1079 *
1080 * HDCP Content Type:
1081 * This Enum property is used by the userspace to declare the content type
1082 * of the display stream, to kernel. Here display stream stands for any
1083 * display content that userspace intended to display through HDCP
1084 * encryption.
1085 *
1086 * Content Type of a stream is decided by the owner of the stream, as
1087 * "HDCP Type0" or "HDCP Type1".
1088 *
1089 * The value of the property can be one of the below:
1090 * - "HDCP Type0": DRM_MODE_HDCP_CONTENT_TYPE0 = 0
1091 * - "HDCP Type1": DRM_MODE_HDCP_CONTENT_TYPE1 = 1
1092 *
1093 * When kernel starts the HDCP authentication (see "Content Protection"
1094 * for details), it uses the content type in "HDCP Content Type"
1095 * for performing the HDCP authentication with the display sink.
1096 *
1097 * Please note in HDCP spec versions, a link can be authenticated with
1098 * HDCP 2.2 for Content Type 0/Content Type 1. Where as a link can be
1099 * authenticated with HDCP1.4 only for Content Type 0(though it is implicit
1100 * in nature. As there is no reference for Content Type in HDCP1.4).
1101 *
1102 * HDCP2.2 authentication protocol itself takes the "Content Type" as a
1103 * parameter, which is a input for the DP HDCP2.2 encryption algo.
1104 *
1105 * In case of Type 0 content protection request, kernel driver can choose
1106 * either of HDCP spec versions 1.4 and 2.2. When HDCP2.2 is used for
1107 * "HDCP Type 0", a HDCP 2.2 capable repeater in the downstream can send
1108 * that content to a HDCP 1.4 authenticated HDCP sink (Type0 link).
1109 * But if the content is classified as "HDCP Type 1", above mentioned
1110 * HDCP 2.2 repeater wont send the content to the HDCP sink as it can't
1111 * authenticate the HDCP1.4 capable sink for "HDCP Type 1".
1112 *
1113 * Please note userspace can be ignorant of the HDCP versions used by the
1114 * kernel driver to achieve the "HDCP Content Type".
1115 *
1116 * At current scenario, classifying a content as Type 1 ensures that the
1117 * content will be displayed only through the HDCP2.2 encrypted link.
1118 *
1119 * Note that the HDCP Content Type property is introduced at HDCP 2.2, and
1120 * defaults to type 0. It is only exposed by drivers supporting HDCP 2.2
1121 * (hence supporting Type 0 and Type 1). Based on how next versions of
1122 * HDCP specs are defined content Type could be used for higher versions
1123 * too.
1124 *
1125 * If content type is changed when "Content Protection" is not UNDESIRED,
1126 * then kernel will disable the HDCP and re-enable with new type in the
1127 * same atomic commit. And when "Content Protection" is ENABLED, it means
1128 * that link is HDCP authenticated and encrypted, for the transmission of
1129 * the Type of stream mentioned at "HDCP Content Type".
1130 *
1131 * HDR_OUTPUT_METADATA:
1132 * Connector property to enable userspace to send HDR Metadata to
1133 * driver. This metadata is based on the composition and blending
1134 * policies decided by user, taking into account the hardware and
1135 * sink capabilities. The driver gets this metadata and creates a
1136 * Dynamic Range and Mastering Infoframe (DRM) in case of HDMI,
1137 * SDP packet (Non-audio INFOFRAME SDP v1.3) for DP. This is then
1138 * sent to sink. This notifies the sink of the upcoming frame's Color
1139 * Encoding and Luminance parameters.
1140 *
1141 * Userspace first need to detect the HDR capabilities of sink by
1142 * reading and parsing the EDID. Details of HDR metadata for HDMI
1143 * are added in CTA 861.G spec. For DP , its defined in VESA DP
1144 * Standard v1.4. It needs to then get the metadata information
1145 * of the video/game/app content which are encoded in HDR (basically
1146 * using HDR transfer functions). With this information it needs to
1147 * decide on a blending policy and compose the relevant
1148 * layers/overlays into a common format. Once this blending is done,
1149 * userspace will be aware of the metadata of the composed frame to
1150 * be send to sink. It then uses this property to communicate this
1151 * metadata to driver which then make a Infoframe packet and sends
1152 * to sink based on the type of encoder connected.
1153 *
1154 * Userspace will be responsible to do Tone mapping operation in case:
1155 * - Some layers are HDR and others are SDR
1156 * - HDR layers luminance is not same as sink
1157 *
1158 * It will even need to do colorspace conversion and get all layers
1159 * to one common colorspace for blending. It can use either GL, Media
1160 * or display engine to get this done based on the capabilities of the
1161 * associated hardware.
1162 *
1163 * Driver expects metadata to be put in &struct hdr_output_metadata
1164 * structure from userspace. This is received as blob and stored in
1165 * &drm_connector_state.hdr_output_metadata. It parses EDID and saves the
1166 * sink metadata in &struct hdr_sink_metadata, as
1167 * &drm_connector.hdr_sink_metadata. Driver uses
1168 * drm_hdmi_infoframe_set_hdr_metadata() helper to set the HDR metadata,
1169 * hdmi_drm_infoframe_pack() to pack the infoframe as per spec, in case of
1170 * HDMI encoder.
1171 *
1172 * max bpc:
1173 * This range property is used by userspace to limit the bit depth. When
1174 * used the driver would limit the bpc in accordance with the valid range
1175 * supported by the hardware and sink. Drivers to use the function
1176 * drm_connector_attach_max_bpc_property() to create and attach the
1177 * property to the connector during initialization.
1178 *
1179 * Connectors also have one standardized atomic property:
1180 *
1181 * CRTC_ID:
1182 * Mode object ID of the &drm_crtc this connector should be connected to.
1183 *
1184 * Connectors for LCD panels may also have one standardized property:
1185 *
1186 * panel orientation:
1187 * On some devices the LCD panel is mounted in the casing in such a way
1188 * that the up/top side of the panel does not match with the top side of
1189 * the device. Userspace can use this property to check for this.
1190 * Note that input coordinates from touchscreens (input devices with
1191 * INPUT_PROP_DIRECT) will still map 1:1 to the actual LCD panel
1192 * coordinates, so if userspace rotates the picture to adjust for
1193 * the orientation it must also apply the same transformation to the
1194 * touchscreen input coordinates. This property is initialized by calling
1195 * drm_connector_set_panel_orientation() or
1196 * drm_connector_set_panel_orientation_with_quirk()
1197 *
1198 * scaling mode:
1199 * This property defines how a non-native mode is upscaled to the native
1200 * mode of an LCD panel:
1201 *
1202 * None:
1203 * No upscaling happens, scaling is left to the panel. Not all
1204 * drivers expose this mode.
1205 * Full:
1206 * The output is upscaled to the full resolution of the panel,
1207 * ignoring the aspect ratio.
1208 * Center:
1209 * No upscaling happens, the output is centered within the native
1210 * resolution the panel.
1211 * Full aspect:
1212 * The output is upscaled to maximize either the width or height
1213 * while retaining the aspect ratio.
1214 *
1215 * This property should be set up by calling
1216 * drm_connector_attach_scaling_mode_property(). Note that drivers
1217 * can also expose this property to external outputs, in which case they
1218 * must support "None", which should be the default (since external screens
1219 * have a built-in scaler).
1220 */
1221
1222int drm_connector_create_standard_properties(struct drm_device *dev)
1223{
1224 struct drm_property *prop;
1225
1226 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1227 DRM_MODE_PROP_IMMUTABLE,
1228 "EDID", 0);
1229 if (!prop)
1230 return -ENOMEM;
1231 dev->mode_config.edid_property = prop;
1232
1233 prop = drm_property_create_enum(dev, 0,
1234 "DPMS", drm_dpms_enum_list,
1235 ARRAY_SIZE(drm_dpms_enum_list));
1236 if (!prop)
1237 return -ENOMEM;
1238 dev->mode_config.dpms_property = prop;
1239
1240 prop = drm_property_create(dev,
1241 DRM_MODE_PROP_BLOB |
1242 DRM_MODE_PROP_IMMUTABLE,
1243 "PATH", 0);
1244 if (!prop)
1245 return -ENOMEM;
1246 dev->mode_config.path_property = prop;
1247
1248 prop = drm_property_create(dev,
1249 DRM_MODE_PROP_BLOB |
1250 DRM_MODE_PROP_IMMUTABLE,
1251 "TILE", 0);
1252 if (!prop)
1253 return -ENOMEM;
1254 dev->mode_config.tile_property = prop;
1255
1256 prop = drm_property_create_enum(dev, 0, "link-status",
1257 drm_link_status_enum_list,
1258 ARRAY_SIZE(drm_link_status_enum_list));
1259 if (!prop)
1260 return -ENOMEM;
1261 dev->mode_config.link_status_property = prop;
1262
1263 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE, "non-desktop");
1264 if (!prop)
1265 return -ENOMEM;
1266 dev->mode_config.non_desktop_property = prop;
1267
1268 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB,
1269 "HDR_OUTPUT_METADATA", 0);
1270 if (!prop)
1271 return -ENOMEM;
1272 dev->mode_config.hdr_output_metadata_property = prop;
1273
1274 return 0;
1275}
1276
1277/**
1278 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1279 * @dev: DRM device
1280 *
1281 * Called by a driver the first time a DVI-I connector is made.
1282 */
1283int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1284{
1285 struct drm_property *dvi_i_selector;
1286 struct drm_property *dvi_i_subconnector;
1287
1288 if (dev->mode_config.dvi_i_select_subconnector_property)
1289 return 0;
1290
1291 dvi_i_selector =
1292 drm_property_create_enum(dev, 0,
1293 "select subconnector",
1294 drm_dvi_i_select_enum_list,
1295 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1296 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1297
1298 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1299 "subconnector",
1300 drm_dvi_i_subconnector_enum_list,
1301 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1302 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1303
1304 return 0;
1305}
1306EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1307
1308/**
1309 * DOC: HDMI connector properties
1310 *
1311 * content type (HDMI specific):
1312 * Indicates content type setting to be used in HDMI infoframes to indicate
1313 * content type for the external device, so that it adjusts its display
1314 * settings accordingly.
1315 *
1316 * The value of this property can be one of the following:
1317 *
1318 * No Data:
1319 * Content type is unknown
1320 * Graphics:
1321 * Content type is graphics
1322 * Photo:
1323 * Content type is photo
1324 * Cinema:
1325 * Content type is cinema
1326 * Game:
1327 * Content type is game
1328 *
1329 * Drivers can set up this property by calling
1330 * drm_connector_attach_content_type_property(). Decoding to
1331 * infoframe values is done through drm_hdmi_avi_infoframe_content_type().
1332 */
1333
1334/**
1335 * drm_connector_attach_content_type_property - attach content-type property
1336 * @connector: connector to attach content type property on.
1337 *
1338 * Called by a driver the first time a HDMI connector is made.
1339 */
1340int drm_connector_attach_content_type_property(struct drm_connector *connector)
1341{
1342 if (!drm_mode_create_content_type_property(connector->dev))
1343 drm_object_attach_property(&connector->base,
1344 connector->dev->mode_config.content_type_property,
1345 DRM_MODE_CONTENT_TYPE_NO_DATA);
1346 return 0;
1347}
1348EXPORT_SYMBOL(drm_connector_attach_content_type_property);
1349
1350
1351/**
1352 * drm_hdmi_avi_infoframe_content_type() - fill the HDMI AVI infoframe
1353 * content type information, based
1354 * on correspondent DRM property.
1355 * @frame: HDMI AVI infoframe
1356 * @conn_state: DRM display connector state
1357 *
1358 */
1359void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
1360 const struct drm_connector_state *conn_state)
1361{
1362 switch (conn_state->content_type) {
1363 case DRM_MODE_CONTENT_TYPE_GRAPHICS:
1364 frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1365 break;
1366 case DRM_MODE_CONTENT_TYPE_CINEMA:
1367 frame->content_type = HDMI_CONTENT_TYPE_CINEMA;
1368 break;
1369 case DRM_MODE_CONTENT_TYPE_GAME:
1370 frame->content_type = HDMI_CONTENT_TYPE_GAME;
1371 break;
1372 case DRM_MODE_CONTENT_TYPE_PHOTO:
1373 frame->content_type = HDMI_CONTENT_TYPE_PHOTO;
1374 break;
1375 default:
1376 /* Graphics is the default(0) */
1377 frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1378 }
1379
1380 frame->itc = conn_state->content_type != DRM_MODE_CONTENT_TYPE_NO_DATA;
1381}
1382EXPORT_SYMBOL(drm_hdmi_avi_infoframe_content_type);
1383
1384/**
1385 * drm_mode_attach_tv_margin_properties - attach TV connector margin properties
1386 * @connector: DRM connector
1387 *
1388 * Called by a driver when it needs to attach TV margin props to a connector.
1389 * Typically used on SDTV and HDMI connectors.
1390 */
1391void drm_connector_attach_tv_margin_properties(struct drm_connector *connector)
1392{
1393 struct drm_device *dev = connector->dev;
1394
1395 drm_object_attach_property(&connector->base,
1396 dev->mode_config.tv_left_margin_property,
1397 0);
1398 drm_object_attach_property(&connector->base,
1399 dev->mode_config.tv_right_margin_property,
1400 0);
1401 drm_object_attach_property(&connector->base,
1402 dev->mode_config.tv_top_margin_property,
1403 0);
1404 drm_object_attach_property(&connector->base,
1405 dev->mode_config.tv_bottom_margin_property,
1406 0);
1407}
1408EXPORT_SYMBOL(drm_connector_attach_tv_margin_properties);
1409
1410/**
1411 * drm_mode_create_tv_margin_properties - create TV connector margin properties
1412 * @dev: DRM device
1413 *
1414 * Called by a driver's HDMI connector initialization routine, this function
1415 * creates the TV margin properties for a given device. No need to call this
1416 * function for an SDTV connector, it's already called from
1417 * drm_mode_create_tv_properties().
1418 */
1419int drm_mode_create_tv_margin_properties(struct drm_device *dev)
1420{
1421 if (dev->mode_config.tv_left_margin_property)
1422 return 0;
1423
1424 dev->mode_config.tv_left_margin_property =
1425 drm_property_create_range(dev, 0, "left margin", 0, 100);
1426 if (!dev->mode_config.tv_left_margin_property)
1427 return -ENOMEM;
1428
1429 dev->mode_config.tv_right_margin_property =
1430 drm_property_create_range(dev, 0, "right margin", 0, 100);
1431 if (!dev->mode_config.tv_right_margin_property)
1432 return -ENOMEM;
1433
1434 dev->mode_config.tv_top_margin_property =
1435 drm_property_create_range(dev, 0, "top margin", 0, 100);
1436 if (!dev->mode_config.tv_top_margin_property)
1437 return -ENOMEM;
1438
1439 dev->mode_config.tv_bottom_margin_property =
1440 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1441 if (!dev->mode_config.tv_bottom_margin_property)
1442 return -ENOMEM;
1443
1444 return 0;
1445}
1446EXPORT_SYMBOL(drm_mode_create_tv_margin_properties);
1447
1448/**
1449 * drm_mode_create_tv_properties - create TV specific connector properties
1450 * @dev: DRM device
1451 * @num_modes: number of different TV formats (modes) supported
1452 * @modes: array of pointers to strings containing name of each format
1453 *
1454 * Called by a driver's TV initialization routine, this function creates
1455 * the TV specific connector properties for a given device. Caller is
1456 * responsible for allocating a list of format names and passing them to
1457 * this routine.
1458 */
1459int drm_mode_create_tv_properties(struct drm_device *dev,
1460 unsigned int num_modes,
1461 const char * const modes[])
1462{
1463 struct drm_property *tv_selector;
1464 struct drm_property *tv_subconnector;
1465 unsigned int i;
1466
1467 if (dev->mode_config.tv_select_subconnector_property)
1468 return 0;
1469
1470 /*
1471 * Basic connector properties
1472 */
1473 tv_selector = drm_property_create_enum(dev, 0,
1474 "select subconnector",
1475 drm_tv_select_enum_list,
1476 ARRAY_SIZE(drm_tv_select_enum_list));
1477 if (!tv_selector)
1478 goto nomem;
1479
1480 dev->mode_config.tv_select_subconnector_property = tv_selector;
1481
1482 tv_subconnector =
1483 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1484 "subconnector",
1485 drm_tv_subconnector_enum_list,
1486 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1487 if (!tv_subconnector)
1488 goto nomem;
1489 dev->mode_config.tv_subconnector_property = tv_subconnector;
1490
1491 /*
1492 * Other, TV specific properties: margins & TV modes.
1493 */
1494 if (drm_mode_create_tv_margin_properties(dev))
1495 goto nomem;
1496
1497 dev->mode_config.tv_mode_property =
1498 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1499 "mode", num_modes);
1500 if (!dev->mode_config.tv_mode_property)
1501 goto nomem;
1502
1503 for (i = 0; i < num_modes; i++)
1504 drm_property_add_enum(dev->mode_config.tv_mode_property,
1505 i, modes[i]);
1506
1507 dev->mode_config.tv_brightness_property =
1508 drm_property_create_range(dev, 0, "brightness", 0, 100);
1509 if (!dev->mode_config.tv_brightness_property)
1510 goto nomem;
1511
1512 dev->mode_config.tv_contrast_property =
1513 drm_property_create_range(dev, 0, "contrast", 0, 100);
1514 if (!dev->mode_config.tv_contrast_property)
1515 goto nomem;
1516
1517 dev->mode_config.tv_flicker_reduction_property =
1518 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1519 if (!dev->mode_config.tv_flicker_reduction_property)
1520 goto nomem;
1521
1522 dev->mode_config.tv_overscan_property =
1523 drm_property_create_range(dev, 0, "overscan", 0, 100);
1524 if (!dev->mode_config.tv_overscan_property)
1525 goto nomem;
1526
1527 dev->mode_config.tv_saturation_property =
1528 drm_property_create_range(dev, 0, "saturation", 0, 100);
1529 if (!dev->mode_config.tv_saturation_property)
1530 goto nomem;
1531
1532 dev->mode_config.tv_hue_property =
1533 drm_property_create_range(dev, 0, "hue", 0, 100);
1534 if (!dev->mode_config.tv_hue_property)
1535 goto nomem;
1536
1537 return 0;
1538nomem:
1539 return -ENOMEM;
1540}
1541EXPORT_SYMBOL(drm_mode_create_tv_properties);
1542
1543/**
1544 * drm_mode_create_scaling_mode_property - create scaling mode property
1545 * @dev: DRM device
1546 *
1547 * Called by a driver the first time it's needed, must be attached to desired
1548 * connectors.
1549 *
1550 * Atomic drivers should use drm_connector_attach_scaling_mode_property()
1551 * instead to correctly assign &drm_connector_state.picture_aspect_ratio
1552 * in the atomic state.
1553 */
1554int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1555{
1556 struct drm_property *scaling_mode;
1557
1558 if (dev->mode_config.scaling_mode_property)
1559 return 0;
1560
1561 scaling_mode =
1562 drm_property_create_enum(dev, 0, "scaling mode",
1563 drm_scaling_mode_enum_list,
1564 ARRAY_SIZE(drm_scaling_mode_enum_list));
1565
1566 dev->mode_config.scaling_mode_property = scaling_mode;
1567
1568 return 0;
1569}
1570EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1571
1572/**
1573 * DOC: Variable refresh properties
1574 *
1575 * Variable refresh rate capable displays can dynamically adjust their
1576 * refresh rate by extending the duration of their vertical front porch
1577 * until page flip or timeout occurs. This can reduce or remove stuttering
1578 * and latency in scenarios where the page flip does not align with the
1579 * vblank interval.
1580 *
1581 * An example scenario would be an application flipping at a constant rate
1582 * of 48Hz on a 60Hz display. The page flip will frequently miss the vblank
1583 * interval and the same contents will be displayed twice. This can be
1584 * observed as stuttering for content with motion.
1585 *
1586 * If variable refresh rate was active on a display that supported a
1587 * variable refresh range from 35Hz to 60Hz no stuttering would be observable
1588 * for the example scenario. The minimum supported variable refresh rate of
1589 * 35Hz is below the page flip frequency and the vertical front porch can
1590 * be extended until the page flip occurs. The vblank interval will be
1591 * directly aligned to the page flip rate.
1592 *
1593 * Not all userspace content is suitable for use with variable refresh rate.
1594 * Large and frequent changes in vertical front porch duration may worsen
1595 * perceived stuttering for input sensitive applications.
1596 *
1597 * Panel brightness will also vary with vertical front porch duration. Some
1598 * panels may have noticeable differences in brightness between the minimum
1599 * vertical front porch duration and the maximum vertical front porch duration.
1600 * Large and frequent changes in vertical front porch duration may produce
1601 * observable flickering for such panels.
1602 *
1603 * Userspace control for variable refresh rate is supported via properties
1604 * on the &drm_connector and &drm_crtc objects.
1605 *
1606 * "vrr_capable":
1607 * Optional &drm_connector boolean property that drivers should attach
1608 * with drm_connector_attach_vrr_capable_property() on connectors that
1609 * could support variable refresh rates. Drivers should update the
1610 * property value by calling drm_connector_set_vrr_capable_property().
1611 *
1612 * Absence of the property should indicate absence of support.
1613 *
1614 * "VRR_ENABLED":
1615 * Default &drm_crtc boolean property that notifies the driver that the
1616 * content on the CRTC is suitable for variable refresh rate presentation.
1617 * The driver will take this property as a hint to enable variable
1618 * refresh rate support if the receiver supports it, ie. if the
1619 * "vrr_capable" property is true on the &drm_connector object. The
1620 * vertical front porch duration will be extended until page-flip or
1621 * timeout when enabled.
1622 *
1623 * The minimum vertical front porch duration is defined as the vertical
1624 * front porch duration for the current mode.
1625 *
1626 * The maximum vertical front porch duration is greater than or equal to
1627 * the minimum vertical front porch duration. The duration is derived
1628 * from the minimum supported variable refresh rate for the connector.
1629 *
1630 * The driver may place further restrictions within these minimum
1631 * and maximum bounds.
1632 */
1633
1634/**
1635 * drm_connector_attach_vrr_capable_property - creates the
1636 * vrr_capable property
1637 * @connector: connector to create the vrr_capable property on.
1638 *
1639 * This is used by atomic drivers to add support for querying
1640 * variable refresh rate capability for a connector.
1641 *
1642 * Returns:
1643 * Zero on success, negative errno on failure.
1644 */
1645int drm_connector_attach_vrr_capable_property(
1646 struct drm_connector *connector)
1647{
1648 struct drm_device *dev = connector->dev;
1649 struct drm_property *prop;
1650
1651 if (!connector->vrr_capable_property) {
1652 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE,
1653 "vrr_capable");
1654 if (!prop)
1655 return -ENOMEM;
1656
1657 connector->vrr_capable_property = prop;
1658 drm_object_attach_property(&connector->base, prop, 0);
1659 }
1660
1661 return 0;
1662}
1663EXPORT_SYMBOL(drm_connector_attach_vrr_capable_property);
1664
1665/**
1666 * drm_connector_attach_scaling_mode_property - attach atomic scaling mode property
1667 * @connector: connector to attach scaling mode property on.
1668 * @scaling_mode_mask: or'ed mask of BIT(%DRM_MODE_SCALE_\*).
1669 *
1670 * This is used to add support for scaling mode to atomic drivers.
1671 * The scaling mode will be set to &drm_connector_state.picture_aspect_ratio
1672 * and can be used from &drm_connector_helper_funcs->atomic_check for validation.
1673 *
1674 * This is the atomic version of drm_mode_create_scaling_mode_property().
1675 *
1676 * Returns:
1677 * Zero on success, negative errno on failure.
1678 */
1679int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1680 u32 scaling_mode_mask)
1681{
1682 struct drm_device *dev = connector->dev;
1683 struct drm_property *scaling_mode_property;
1684 int i;
1685 const unsigned valid_scaling_mode_mask =
1686 (1U << ARRAY_SIZE(drm_scaling_mode_enum_list)) - 1;
1687
1688 if (WARN_ON(hweight32(scaling_mode_mask) < 2 ||
1689 scaling_mode_mask & ~valid_scaling_mode_mask))
1690 return -EINVAL;
1691
1692 scaling_mode_property =
1693 drm_property_create(dev, DRM_MODE_PROP_ENUM, "scaling mode",
1694 hweight32(scaling_mode_mask));
1695
1696 if (!scaling_mode_property)
1697 return -ENOMEM;
1698
1699 for (i = 0; i < ARRAY_SIZE(drm_scaling_mode_enum_list); i++) {
1700 int ret;
1701
1702 if (!(BIT(i) & scaling_mode_mask))
1703 continue;
1704
1705 ret = drm_property_add_enum(scaling_mode_property,
1706 drm_scaling_mode_enum_list[i].type,
1707 drm_scaling_mode_enum_list[i].name);
1708
1709 if (ret) {
1710 drm_property_destroy(dev, scaling_mode_property);
1711
1712 return ret;
1713 }
1714 }
1715
1716 drm_object_attach_property(&connector->base,
1717 scaling_mode_property, 0);
1718
1719 connector->scaling_mode_property = scaling_mode_property;
1720
1721 return 0;
1722}
1723EXPORT_SYMBOL(drm_connector_attach_scaling_mode_property);
1724
1725/**
1726 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1727 * @dev: DRM device
1728 *
1729 * Called by a driver the first time it's needed, must be attached to desired
1730 * connectors.
1731 *
1732 * Returns:
1733 * Zero on success, negative errno on failure.
1734 */
1735int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1736{
1737 if (dev->mode_config.aspect_ratio_property)
1738 return 0;
1739
1740 dev->mode_config.aspect_ratio_property =
1741 drm_property_create_enum(dev, 0, "aspect ratio",
1742 drm_aspect_ratio_enum_list,
1743 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1744
1745 if (dev->mode_config.aspect_ratio_property == NULL)
1746 return -ENOMEM;
1747
1748 return 0;
1749}
1750EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1751
1752/**
1753 * DOC: standard connector properties
1754 *
1755 * Colorspace:
1756 * This property helps select a suitable colorspace based on the sink
1757 * capability. Modern sink devices support wider gamut like BT2020.
1758 * This helps switch to BT2020 mode if the BT2020 encoded video stream
1759 * is being played by the user, same for any other colorspace. Thereby
1760 * giving a good visual experience to users.
1761 *
1762 * The expectation from userspace is that it should parse the EDID
1763 * and get supported colorspaces. Use this property and switch to the
1764 * one supported. Sink supported colorspaces should be retrieved by
1765 * userspace from EDID and driver will not explicitly expose them.
1766 *
1767 * Basically the expectation from userspace is:
1768 * - Set up CRTC DEGAMMA/CTM/GAMMA to convert to some sink
1769 * colorspace
1770 * - Set this new property to let the sink know what it
1771 * converted the CRTC output to.
1772 * - This property is just to inform sink what colorspace
1773 * source is trying to drive.
1774 *
1775 * Because between HDMI and DP have different colorspaces,
1776 * drm_mode_create_hdmi_colorspace_property() is used for HDMI connector and
1777 * drm_mode_create_dp_colorspace_property() is used for DP connector.
1778 */
1779
1780/**
1781 * drm_mode_create_hdmi_colorspace_property - create hdmi colorspace property
1782 * @connector: connector to create the Colorspace property on.
1783 *
1784 * Called by a driver the first time it's needed, must be attached to desired
1785 * HDMI connectors.
1786 *
1787 * Returns:
1788 * Zero on success, negative errno on failure.
1789 */
1790int drm_mode_create_hdmi_colorspace_property(struct drm_connector *connector)
1791{
1792 struct drm_device *dev = connector->dev;
1793
1794 if (connector->colorspace_property)
1795 return 0;
1796
1797 connector->colorspace_property =
1798 drm_property_create_enum(dev, DRM_MODE_PROP_ENUM, "Colorspace",
1799 hdmi_colorspaces,
1800 ARRAY_SIZE(hdmi_colorspaces));
1801
1802 if (!connector->colorspace_property)
1803 return -ENOMEM;
1804
1805 return 0;
1806}
1807EXPORT_SYMBOL(drm_mode_create_hdmi_colorspace_property);
1808
1809/**
1810 * drm_mode_create_dp_colorspace_property - create dp colorspace property
1811 * @connector: connector to create the Colorspace property on.
1812 *
1813 * Called by a driver the first time it's needed, must be attached to desired
1814 * DP connectors.
1815 *
1816 * Returns:
1817 * Zero on success, negative errno on failure.
1818 */
1819int drm_mode_create_dp_colorspace_property(struct drm_connector *connector)
1820{
1821 struct drm_device *dev = connector->dev;
1822
1823 if (connector->colorspace_property)
1824 return 0;
1825
1826 connector->colorspace_property =
1827 drm_property_create_enum(dev, DRM_MODE_PROP_ENUM, "Colorspace",
1828 dp_colorspaces,
1829 ARRAY_SIZE(dp_colorspaces));
1830
1831 if (!connector->colorspace_property)
1832 return -ENOMEM;
1833
1834 return 0;
1835}
1836EXPORT_SYMBOL(drm_mode_create_dp_colorspace_property);
1837
1838/**
1839 * drm_mode_create_content_type_property - create content type property
1840 * @dev: DRM device
1841 *
1842 * Called by a driver the first time it's needed, must be attached to desired
1843 * connectors.
1844 *
1845 * Returns:
1846 * Zero on success, negative errno on failure.
1847 */
1848int drm_mode_create_content_type_property(struct drm_device *dev)
1849{
1850 if (dev->mode_config.content_type_property)
1851 return 0;
1852
1853 dev->mode_config.content_type_property =
1854 drm_property_create_enum(dev, 0, "content type",
1855 drm_content_type_enum_list,
1856 ARRAY_SIZE(drm_content_type_enum_list));
1857
1858 if (dev->mode_config.content_type_property == NULL)
1859 return -ENOMEM;
1860
1861 return 0;
1862}
1863EXPORT_SYMBOL(drm_mode_create_content_type_property);
1864
1865/**
1866 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1867 * @dev: DRM device
1868 *
1869 * Create the suggested x/y offset property for connectors.
1870 */
1871int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1872{
1873 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1874 return 0;
1875
1876 dev->mode_config.suggested_x_property =
1877 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1878
1879 dev->mode_config.suggested_y_property =
1880 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1881
1882 if (dev->mode_config.suggested_x_property == NULL ||
1883 dev->mode_config.suggested_y_property == NULL)
1884 return -ENOMEM;
1885 return 0;
1886}
1887EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1888
1889/**
1890 * drm_connector_set_path_property - set tile property on connector
1891 * @connector: connector to set property on.
1892 * @path: path to use for property; must not be NULL.
1893 *
1894 * This creates a property to expose to userspace to specify a
1895 * connector path. This is mainly used for DisplayPort MST where
1896 * connectors have a topology and we want to allow userspace to give
1897 * them more meaningful names.
1898 *
1899 * Returns:
1900 * Zero on success, negative errno on failure.
1901 */
1902int drm_connector_set_path_property(struct drm_connector *connector,
1903 const char *path)
1904{
1905 struct drm_device *dev = connector->dev;
1906 int ret;
1907
1908 ret = drm_property_replace_global_blob(dev,
1909 &connector->path_blob_ptr,
1910 strlen(path) + 1,
1911 path,
1912 &connector->base,
1913 dev->mode_config.path_property);
1914 return ret;
1915}
1916EXPORT_SYMBOL(drm_connector_set_path_property);
1917
1918/**
1919 * drm_connector_set_tile_property - set tile property on connector
1920 * @connector: connector to set property on.
1921 *
1922 * This looks up the tile information for a connector, and creates a
1923 * property for userspace to parse if it exists. The property is of
1924 * the form of 8 integers using ':' as a separator.
1925 * This is used for dual port tiled displays with DisplayPort SST
1926 * or DisplayPort MST connectors.
1927 *
1928 * Returns:
1929 * Zero on success, errno on failure.
1930 */
1931int drm_connector_set_tile_property(struct drm_connector *connector)
1932{
1933 struct drm_device *dev = connector->dev;
1934 char tile[256];
1935 int ret;
1936
1937 if (!connector->has_tile) {
1938 ret = drm_property_replace_global_blob(dev,
1939 &connector->tile_blob_ptr,
1940 0,
1941 NULL,
1942 &connector->base,
1943 dev->mode_config.tile_property);
1944 return ret;
1945 }
1946
1947 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
1948 connector->tile_group->id, connector->tile_is_single_monitor,
1949 connector->num_h_tile, connector->num_v_tile,
1950 connector->tile_h_loc, connector->tile_v_loc,
1951 connector->tile_h_size, connector->tile_v_size);
1952
1953 ret = drm_property_replace_global_blob(dev,
1954 &connector->tile_blob_ptr,
1955 strlen(tile) + 1,
1956 tile,
1957 &connector->base,
1958 dev->mode_config.tile_property);
1959 return ret;
1960}
1961EXPORT_SYMBOL(drm_connector_set_tile_property);
1962
1963/**
1964 * drm_connector_update_edid_property - update the edid property of a connector
1965 * @connector: drm connector
1966 * @edid: new value of the edid property
1967 *
1968 * This function creates a new blob modeset object and assigns its id to the
1969 * connector's edid property.
1970 * Since we also parse tile information from EDID's displayID block, we also
1971 * set the connector's tile property here. See drm_connector_set_tile_property()
1972 * for more details.
1973 *
1974 * Returns:
1975 * Zero on success, negative errno on failure.
1976 */
1977int drm_connector_update_edid_property(struct drm_connector *connector,
1978 const struct edid *edid)
1979{
1980 struct drm_device *dev = connector->dev;
1981 size_t size = 0;
1982 int ret;
1983 const struct edid *old_edid;
1984
1985 /* ignore requests to set edid when overridden */
1986 if (connector->override_edid)
1987 return 0;
1988
1989 if (edid)
1990 size = EDID_LENGTH * (1 + edid->extensions);
1991
1992 /* Set the display info, using edid if available, otherwise
1993 * resetting the values to defaults. This duplicates the work
1994 * done in drm_add_edid_modes, but that function is not
1995 * consistently called before this one in all drivers and the
1996 * computation is cheap enough that it seems better to
1997 * duplicate it rather than attempt to ensure some arbitrary
1998 * ordering of calls.
1999 */
2000 if (edid)
2001 drm_add_display_info(connector, edid);
2002 else
2003 drm_reset_display_info(connector);
2004
2005 drm_update_tile_info(connector, edid);
2006
2007 if (connector->edid_blob_ptr) {
2008 old_edid = (const struct edid *)connector->edid_blob_ptr->data;
2009 if (old_edid) {
2010 if (!drm_edid_are_equal(edid, old_edid)) {
2011 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] Edid was changed.\n",
2012 connector->base.id, connector->name);
2013
2014 connector->epoch_counter += 1;
2015 DRM_DEBUG_KMS("Updating change counter to %llu\n",
2016 connector->epoch_counter);
2017 }
2018 }
2019 }
2020
2021 drm_object_property_set_value(&connector->base,
2022 dev->mode_config.non_desktop_property,
2023 connector->display_info.non_desktop);
2024
2025 ret = drm_property_replace_global_blob(dev,
2026 &connector->edid_blob_ptr,
2027 size,
2028 edid,
2029 &connector->base,
2030 dev->mode_config.edid_property);
2031 if (ret)
2032 return ret;
2033 return drm_connector_set_tile_property(connector);
2034}
2035EXPORT_SYMBOL(drm_connector_update_edid_property);
2036
2037/**
2038 * drm_connector_set_link_status_property - Set link status property of a connector
2039 * @connector: drm connector
2040 * @link_status: new value of link status property (0: Good, 1: Bad)
2041 *
2042 * In usual working scenario, this link status property will always be set to
2043 * "GOOD". If something fails during or after a mode set, the kernel driver
2044 * may set this link status property to "BAD". The caller then needs to send a
2045 * hotplug uevent for userspace to re-check the valid modes through
2046 * GET_CONNECTOR_IOCTL and retry modeset.
2047 *
2048 * Note: Drivers cannot rely on userspace to support this property and
2049 * issue a modeset. As such, they may choose to handle issues (like
2050 * re-training a link) without userspace's intervention.
2051 *
2052 * The reason for adding this property is to handle link training failures, but
2053 * it is not limited to DP or link training. For example, if we implement
2054 * asynchronous setcrtc, this property can be used to report any failures in that.
2055 */
2056void drm_connector_set_link_status_property(struct drm_connector *connector,
2057 uint64_t link_status)
2058{
2059 struct drm_device *dev = connector->dev;
2060
2061 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2062 connector->state->link_status = link_status;
2063 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2064}
2065EXPORT_SYMBOL(drm_connector_set_link_status_property);
2066
2067/**
2068 * drm_connector_attach_max_bpc_property - attach "max bpc" property
2069 * @connector: connector to attach max bpc property on.
2070 * @min: The minimum bit depth supported by the connector.
2071 * @max: The maximum bit depth supported by the connector.
2072 *
2073 * This is used to add support for limiting the bit depth on a connector.
2074 *
2075 * Returns:
2076 * Zero on success, negative errno on failure.
2077 */
2078int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
2079 int min, int max)
2080{
2081 struct drm_device *dev = connector->dev;
2082 struct drm_property *prop;
2083
2084 prop = connector->max_bpc_property;
2085 if (!prop) {
2086 prop = drm_property_create_range(dev, 0, "max bpc", min, max);
2087 if (!prop)
2088 return -ENOMEM;
2089
2090 connector->max_bpc_property = prop;
2091 }
2092
2093 drm_object_attach_property(&connector->base, prop, max);
2094 connector->state->max_requested_bpc = max;
2095 connector->state->max_bpc = max;
2096
2097 return 0;
2098}
2099EXPORT_SYMBOL(drm_connector_attach_max_bpc_property);
2100
2101/**
2102 * drm_connector_set_vrr_capable_property - sets the variable refresh rate
2103 * capable property for a connector
2104 * @connector: drm connector
2105 * @capable: True if the connector is variable refresh rate capable
2106 *
2107 * Should be used by atomic drivers to update the indicated support for
2108 * variable refresh rate over a connector.
2109 */
2110void drm_connector_set_vrr_capable_property(
2111 struct drm_connector *connector, bool capable)
2112{
2113 drm_object_property_set_value(&connector->base,
2114 connector->vrr_capable_property,
2115 capable);
2116}
2117EXPORT_SYMBOL(drm_connector_set_vrr_capable_property);
2118
2119/**
2120 * drm_connector_set_panel_orientation - sets the connector's panel_orientation
2121 * @connector: connector for which to set the panel-orientation property.
2122 * @panel_orientation: drm_panel_orientation value to set
2123 *
2124 * This function sets the connector's panel_orientation and attaches
2125 * a "panel orientation" property to the connector.
2126 *
2127 * Calling this function on a connector where the panel_orientation has
2128 * already been set is a no-op (e.g. the orientation has been overridden with
2129 * a kernel commandline option).
2130 *
2131 * It is allowed to call this function with a panel_orientation of
2132 * DRM_MODE_PANEL_ORIENTATION_UNKNOWN, in which case it is a no-op.
2133 *
2134 * Returns:
2135 * Zero on success, negative errno on failure.
2136 */
2137int drm_connector_set_panel_orientation(
2138 struct drm_connector *connector,
2139 enum drm_panel_orientation panel_orientation)
2140{
2141 struct drm_device *dev = connector->dev;
2142 struct drm_display_info *info = &connector->display_info;
2143 struct drm_property *prop;
2144
2145 /* Already set? */
2146 if (info->panel_orientation != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2147 return 0;
2148
2149 /* Don't attach the property if the orientation is unknown */
2150 if (panel_orientation == DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2151 return 0;
2152
2153 info->panel_orientation = panel_orientation;
2154
2155 prop = dev->mode_config.panel_orientation_property;
2156 if (!prop) {
2157 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
2158 "panel orientation",
2159 drm_panel_orientation_enum_list,
2160 ARRAY_SIZE(drm_panel_orientation_enum_list));
2161 if (!prop)
2162 return -ENOMEM;
2163
2164 dev->mode_config.panel_orientation_property = prop;
2165 }
2166
2167 drm_object_attach_property(&connector->base, prop,
2168 info->panel_orientation);
2169 return 0;
2170}
2171EXPORT_SYMBOL(drm_connector_set_panel_orientation);
2172
2173/**
2174 * drm_connector_set_panel_orientation_with_quirk -
2175 * set the connector's panel_orientation after checking for quirks
2176 * @connector: connector for which to init the panel-orientation property.
2177 * @panel_orientation: drm_panel_orientation value to set
2178 * @width: width in pixels of the panel, used for panel quirk detection
2179 * @height: height in pixels of the panel, used for panel quirk detection
2180 *
2181 * Like drm_connector_set_panel_orientation(), but with a check for platform
2182 * specific (e.g. DMI based) quirks overriding the passed in panel_orientation.
2183 *
2184 * Returns:
2185 * Zero on success, negative errno on failure.
2186 */
2187int drm_connector_set_panel_orientation_with_quirk(
2188 struct drm_connector *connector,
2189 enum drm_panel_orientation panel_orientation,
2190 int width, int height)
2191{
2192 int orientation_quirk;
2193
2194 orientation_quirk = drm_get_panel_orientation_quirk(width, height);
2195 if (orientation_quirk != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2196 panel_orientation = orientation_quirk;
2197
2198 return drm_connector_set_panel_orientation(connector,
2199 panel_orientation);
2200}
2201EXPORT_SYMBOL(drm_connector_set_panel_orientation_with_quirk);
2202
2203int drm_connector_set_obj_prop(struct drm_mode_object *obj,
2204 struct drm_property *property,
2205 uint64_t value)
2206{
2207 int ret = -EINVAL;
2208 struct drm_connector *connector = obj_to_connector(obj);
2209
2210 /* Do DPMS ourselves */
2211 if (property == connector->dev->mode_config.dpms_property) {
2212 ret = (*connector->funcs->dpms)(connector, (int)value);
2213 } else if (connector->funcs->set_property)
2214 ret = connector->funcs->set_property(connector, property, value);
2215
2216 if (!ret)
2217 drm_object_property_set_value(&connector->base, property, value);
2218 return ret;
2219}
2220
2221int drm_connector_property_set_ioctl(struct drm_device *dev,
2222 void *data, struct drm_file *file_priv)
2223{
2224 struct drm_mode_connector_set_property *conn_set_prop = data;
2225 struct drm_mode_obj_set_property obj_set_prop = {
2226 .value = conn_set_prop->value,
2227 .prop_id = conn_set_prop->prop_id,
2228 .obj_id = conn_set_prop->connector_id,
2229 .obj_type = DRM_MODE_OBJECT_CONNECTOR
2230 };
2231
2232 /* It does all the locking and checking we need */
2233 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
2234}
2235
2236static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
2237{
2238 /* For atomic drivers only state objects are synchronously updated and
2239 * protected by modeset locks, so check those first. */
2240 if (connector->state)
2241 return connector->state->best_encoder;
2242 return connector->encoder;
2243}
2244
2245static bool
2246drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
2247 const struct list_head *export_list,
2248 const struct drm_file *file_priv)
2249{
2250 /*
2251 * If user-space hasn't configured the driver to expose the stereo 3D
2252 * modes, don't expose them.
2253 */
2254 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
2255 return false;
2256 /*
2257 * If user-space hasn't configured the driver to expose the modes
2258 * with aspect-ratio, don't expose them. However if such a mode
2259 * is unique, let it be exposed, but reset the aspect-ratio flags
2260 * while preparing the list of user-modes.
2261 */
2262 if (!file_priv->aspect_ratio_allowed) {
2263 struct drm_display_mode *mode_itr;
2264
2265 list_for_each_entry(mode_itr, export_list, export_head)
2266 if (drm_mode_match(mode_itr, mode,
2267 DRM_MODE_MATCH_TIMINGS |
2268 DRM_MODE_MATCH_CLOCK |
2269 DRM_MODE_MATCH_FLAGS |
2270 DRM_MODE_MATCH_3D_FLAGS))
2271 return false;
2272 }
2273
2274 return true;
2275}
2276
2277int drm_mode_getconnector(struct drm_device *dev, void *data,
2278 struct drm_file *file_priv)
2279{
2280 struct drm_mode_get_connector *out_resp = data;
2281 struct drm_connector *connector;
2282 struct drm_encoder *encoder;
2283 struct drm_display_mode *mode;
2284 int mode_count = 0;
2285 int encoders_count = 0;
2286 int ret = 0;
2287 int copied = 0;
2288 struct drm_mode_modeinfo u_mode;
2289 struct drm_mode_modeinfo __user *mode_ptr;
2290 uint32_t __user *encoder_ptr;
2291 LIST_HEAD(export_list);
2292
2293 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2294 return -EOPNOTSUPP;
2295
2296 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2297
2298 connector = drm_connector_lookup(dev, file_priv, out_resp->connector_id);
2299 if (!connector)
2300 return -ENOENT;
2301
2302 encoders_count = hweight32(connector->possible_encoders);
2303
2304 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2305 copied = 0;
2306 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2307
2308 drm_connector_for_each_possible_encoder(connector, encoder) {
2309 if (put_user(encoder->base.id, encoder_ptr + copied)) {
2310 ret = -EFAULT;
2311 goto out;
2312 }
2313 copied++;
2314 }
2315 }
2316 out_resp->count_encoders = encoders_count;
2317
2318 out_resp->connector_id = connector->base.id;
2319 out_resp->connector_type = connector->connector_type;
2320 out_resp->connector_type_id = connector->connector_type_id;
2321
2322 mutex_lock(&dev->mode_config.mutex);
2323 if (out_resp->count_modes == 0) {
2324 connector->funcs->fill_modes(connector,
2325 dev->mode_config.max_width,
2326 dev->mode_config.max_height);
2327 }
2328
2329 out_resp->mm_width = connector->display_info.width_mm;
2330 out_resp->mm_height = connector->display_info.height_mm;
2331 out_resp->subpixel = connector->display_info.subpixel_order;
2332 out_resp->connection = connector->status;
2333
2334 /* delayed so we get modes regardless of pre-fill_modes state */
2335 list_for_each_entry(mode, &connector->modes, head)
2336 if (drm_mode_expose_to_userspace(mode, &export_list,
2337 file_priv)) {
2338 list_add_tail(&mode->export_head, &export_list);
2339 mode_count++;
2340 }
2341
2342 /*
2343 * This ioctl is called twice, once to determine how much space is
2344 * needed, and the 2nd time to fill it.
2345 * The modes that need to be exposed to the user are maintained in the
2346 * 'export_list'. When the ioctl is called first time to determine the,
2347 * space, the export_list gets filled, to find the no.of modes. In the
2348 * 2nd time, the user modes are filled, one by one from the export_list.
2349 */
2350 if ((out_resp->count_modes >= mode_count) && mode_count) {
2351 copied = 0;
2352 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2353 list_for_each_entry(mode, &export_list, export_head) {
2354 drm_mode_convert_to_umode(&u_mode, mode);
2355 /*
2356 * Reset aspect ratio flags of user-mode, if modes with
2357 * aspect-ratio are not supported.
2358 */
2359 if (!file_priv->aspect_ratio_allowed)
2360 u_mode.flags &= ~DRM_MODE_FLAG_PIC_AR_MASK;
2361 if (copy_to_user(mode_ptr + copied,
2362 &u_mode, sizeof(u_mode))) {
2363 ret = -EFAULT;
2364 mutex_unlock(&dev->mode_config.mutex);
2365
2366 goto out;
2367 }
2368 copied++;
2369 }
2370 }
2371 out_resp->count_modes = mode_count;
2372 mutex_unlock(&dev->mode_config.mutex);
2373
2374 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2375 encoder = drm_connector_get_encoder(connector);
2376 if (encoder)
2377 out_resp->encoder_id = encoder->base.id;
2378 else
2379 out_resp->encoder_id = 0;
2380
2381 /* Only grab properties after probing, to make sure EDID and other
2382 * properties reflect the latest status. */
2383 ret = drm_mode_object_get_properties(&connector->base, file_priv->atomic,
2384 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
2385 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
2386 &out_resp->count_props);
2387 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2388
2389out:
2390 drm_connector_put(connector);
2391
2392 return ret;
2393}
2394
2395
2396/**
2397 * DOC: Tile group
2398 *
2399 * Tile groups are used to represent tiled monitors with a unique integer
2400 * identifier. Tiled monitors using DisplayID v1.3 have a unique 8-byte handle,
2401 * we store this in a tile group, so we have a common identifier for all tiles
2402 * in a monitor group. The property is called "TILE". Drivers can manage tile
2403 * groups using drm_mode_create_tile_group(), drm_mode_put_tile_group() and
2404 * drm_mode_get_tile_group(). But this is only needed for internal panels where
2405 * the tile group information is exposed through a non-standard way.
2406 */
2407
2408static void drm_tile_group_free(struct kref *kref)
2409{
2410 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
2411 struct drm_device *dev = tg->dev;
2412
2413 mutex_lock(&dev->mode_config.idr_mutex);
2414 idr_remove(&dev->mode_config.tile_idr, tg->id);
2415 mutex_unlock(&dev->mode_config.idr_mutex);
2416 kfree(tg);
2417}
2418
2419/**
2420 * drm_mode_put_tile_group - drop a reference to a tile group.
2421 * @dev: DRM device
2422 * @tg: tile group to drop reference to.
2423 *
2424 * drop reference to tile group and free if 0.
2425 */
2426void drm_mode_put_tile_group(struct drm_device *dev,
2427 struct drm_tile_group *tg)
2428{
2429 kref_put(&tg->refcount, drm_tile_group_free);
2430}
2431EXPORT_SYMBOL(drm_mode_put_tile_group);
2432
2433/**
2434 * drm_mode_get_tile_group - get a reference to an existing tile group
2435 * @dev: DRM device
2436 * @topology: 8-bytes unique per monitor.
2437 *
2438 * Use the unique bytes to get a reference to an existing tile group.
2439 *
2440 * RETURNS:
2441 * tile group or NULL if not found.
2442 */
2443struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
2444 const char topology[8])
2445{
2446 struct drm_tile_group *tg;
2447 int id;
2448
2449 mutex_lock(&dev->mode_config.idr_mutex);
2450 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
2451 if (!memcmp(tg->group_data, topology, 8)) {
2452 if (!kref_get_unless_zero(&tg->refcount))
2453 tg = NULL;
2454 mutex_unlock(&dev->mode_config.idr_mutex);
2455 return tg;
2456 }
2457 }
2458 mutex_unlock(&dev->mode_config.idr_mutex);
2459 return NULL;
2460}
2461EXPORT_SYMBOL(drm_mode_get_tile_group);
2462
2463/**
2464 * drm_mode_create_tile_group - create a tile group from a displayid description
2465 * @dev: DRM device
2466 * @topology: 8-bytes unique per monitor.
2467 *
2468 * Create a tile group for the unique monitor, and get a unique
2469 * identifier for the tile group.
2470 *
2471 * RETURNS:
2472 * new tile group or NULL.
2473 */
2474struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
2475 const char topology[8])
2476{
2477 struct drm_tile_group *tg;
2478 int ret;
2479
2480 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
2481 if (!tg)
2482 return NULL;
2483
2484 kref_init(&tg->refcount);
2485 memcpy(tg->group_data, topology, 8);
2486 tg->dev = dev;
2487
2488 mutex_lock(&dev->mode_config.idr_mutex);
2489 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
2490 if (ret >= 0) {
2491 tg->id = ret;
2492 } else {
2493 kfree(tg);
2494 tg = NULL;
2495 }
2496
2497 mutex_unlock(&dev->mode_config.idr_mutex);
2498 return tg;
2499}
2500EXPORT_SYMBOL(drm_mode_create_tile_group);
1/*
2 * Copyright (c) 2016 Intel Corporation
3 *
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.
13 *
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
20 * OF THIS SOFTWARE.
21 */
22
23#include <drm/drm_auth.h>
24#include <drm/drm_connector.h>
25#include <drm/drm_edid.h>
26#include <drm/drm_encoder.h>
27#include <drm/drm_utils.h>
28#include <drm/drm_print.h>
29#include <drm/drm_drv.h>
30#include <drm/drm_file.h>
31#include <drm/drm_sysfs.h>
32
33#include <linux/uaccess.h>
34
35#include "drm_crtc_internal.h"
36#include "drm_internal.h"
37
38/**
39 * DOC: overview
40 *
41 * In DRM connectors are the general abstraction for display sinks, and include
42 * also fixed panels or anything else that can display pixels in some form. As
43 * opposed to all other KMS objects representing hardware (like CRTC, encoder or
44 * plane abstractions) connectors can be hotplugged and unplugged at runtime.
45 * Hence they are reference-counted using drm_connector_get() and
46 * drm_connector_put().
47 *
48 * KMS driver must create, initialize, register and attach at a &struct
49 * drm_connector for each such sink. The instance is created as other KMS
50 * objects and initialized by setting the following fields. The connector is
51 * initialized with a call to drm_connector_init() with a pointer to the
52 * &struct drm_connector_funcs and a connector type, and then exposed to
53 * userspace with a call to drm_connector_register().
54 *
55 * Connectors must be attached to an encoder to be used. For devices that map
56 * connectors to encoders 1:1, the connector should be attached at
57 * initialization time with a call to drm_connector_attach_encoder(). The
58 * driver must also set the &drm_connector.encoder field to point to the
59 * attached encoder.
60 *
61 * For connectors which are not fixed (like built-in panels) the driver needs to
62 * support hotplug notifications. The simplest way to do that is by using the
63 * probe helpers, see drm_kms_helper_poll_init() for connectors which don't have
64 * hardware support for hotplug interrupts. Connectors with hardware hotplug
65 * support can instead use e.g. drm_helper_hpd_irq_event().
66 */
67
68struct drm_conn_prop_enum_list {
69 int type;
70 const char *name;
71 struct ida ida;
72};
73
74/*
75 * Connector and encoder types.
76 */
77static struct drm_conn_prop_enum_list drm_connector_enum_list[] = {
78 { DRM_MODE_CONNECTOR_Unknown, "Unknown" },
79 { DRM_MODE_CONNECTOR_VGA, "VGA" },
80 { DRM_MODE_CONNECTOR_DVII, "DVI-I" },
81 { DRM_MODE_CONNECTOR_DVID, "DVI-D" },
82 { DRM_MODE_CONNECTOR_DVIA, "DVI-A" },
83 { DRM_MODE_CONNECTOR_Composite, "Composite" },
84 { DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO" },
85 { DRM_MODE_CONNECTOR_LVDS, "LVDS" },
86 { DRM_MODE_CONNECTOR_Component, "Component" },
87 { DRM_MODE_CONNECTOR_9PinDIN, "DIN" },
88 { DRM_MODE_CONNECTOR_DisplayPort, "DP" },
89 { DRM_MODE_CONNECTOR_HDMIA, "HDMI-A" },
90 { DRM_MODE_CONNECTOR_HDMIB, "HDMI-B" },
91 { DRM_MODE_CONNECTOR_TV, "TV" },
92 { DRM_MODE_CONNECTOR_eDP, "eDP" },
93 { DRM_MODE_CONNECTOR_VIRTUAL, "Virtual" },
94 { DRM_MODE_CONNECTOR_DSI, "DSI" },
95 { DRM_MODE_CONNECTOR_DPI, "DPI" },
96 { DRM_MODE_CONNECTOR_WRITEBACK, "Writeback" },
97 { DRM_MODE_CONNECTOR_SPI, "SPI" },
98 { DRM_MODE_CONNECTOR_USB, "USB" },
99};
100
101void drm_connector_ida_init(void)
102{
103 int i;
104
105 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
106 ida_init(&drm_connector_enum_list[i].ida);
107}
108
109void drm_connector_ida_destroy(void)
110{
111 int i;
112
113 for (i = 0; i < ARRAY_SIZE(drm_connector_enum_list); i++)
114 ida_destroy(&drm_connector_enum_list[i].ida);
115}
116
117/**
118 * drm_get_connector_type_name - return a string for connector type
119 * @type: The connector type (DRM_MODE_CONNECTOR_*)
120 *
121 * Returns: the name of the connector type, or NULL if the type is not valid.
122 */
123const char *drm_get_connector_type_name(unsigned int type)
124{
125 if (type < ARRAY_SIZE(drm_connector_enum_list))
126 return drm_connector_enum_list[type].name;
127
128 return NULL;
129}
130EXPORT_SYMBOL(drm_get_connector_type_name);
131
132/**
133 * drm_connector_get_cmdline_mode - reads the user's cmdline mode
134 * @connector: connector to query
135 *
136 * The kernel supports per-connector configuration of its consoles through
137 * use of the video= parameter. This function parses that option and
138 * extracts the user's specified mode (or enable/disable status) for a
139 * particular connector. This is typically only used during the early fbdev
140 * setup.
141 */
142static void drm_connector_get_cmdline_mode(struct drm_connector *connector)
143{
144 struct drm_cmdline_mode *mode = &connector->cmdline_mode;
145 char *option = NULL;
146
147 if (fb_get_options(connector->name, &option))
148 return;
149
150 if (!drm_mode_parse_command_line_for_connector(option,
151 connector,
152 mode))
153 return;
154
155 if (mode->force) {
156 DRM_INFO("forcing %s connector %s\n", connector->name,
157 drm_get_connector_force_name(mode->force));
158 connector->force = mode->force;
159 }
160
161 if (mode->panel_orientation != DRM_MODE_PANEL_ORIENTATION_UNKNOWN) {
162 DRM_INFO("cmdline forces connector %s panel_orientation to %d\n",
163 connector->name, mode->panel_orientation);
164 drm_connector_set_panel_orientation(connector,
165 mode->panel_orientation);
166 }
167
168 DRM_DEBUG_KMS("cmdline mode for connector %s %s %dx%d@%dHz%s%s%s\n",
169 connector->name, mode->name,
170 mode->xres, mode->yres,
171 mode->refresh_specified ? mode->refresh : 60,
172 mode->rb ? " reduced blanking" : "",
173 mode->margins ? " with margins" : "",
174 mode->interlace ? " interlaced" : "");
175}
176
177static void drm_connector_free(struct kref *kref)
178{
179 struct drm_connector *connector =
180 container_of(kref, struct drm_connector, base.refcount);
181 struct drm_device *dev = connector->dev;
182
183 drm_mode_object_unregister(dev, &connector->base);
184 connector->funcs->destroy(connector);
185}
186
187void drm_connector_free_work_fn(struct work_struct *work)
188{
189 struct drm_connector *connector, *n;
190 struct drm_device *dev =
191 container_of(work, struct drm_device, mode_config.connector_free_work);
192 struct drm_mode_config *config = &dev->mode_config;
193 unsigned long flags;
194 struct llist_node *freed;
195
196 spin_lock_irqsave(&config->connector_list_lock, flags);
197 freed = llist_del_all(&config->connector_free_list);
198 spin_unlock_irqrestore(&config->connector_list_lock, flags);
199
200 llist_for_each_entry_safe(connector, n, freed, free_node) {
201 drm_mode_object_unregister(dev, &connector->base);
202 connector->funcs->destroy(connector);
203 }
204}
205
206/**
207 * drm_connector_init - Init a preallocated connector
208 * @dev: DRM device
209 * @connector: the connector to init
210 * @funcs: callbacks for this connector
211 * @connector_type: user visible type of the connector
212 *
213 * Initialises a preallocated connector. Connectors should be
214 * subclassed as part of driver connector objects.
215 *
216 * Returns:
217 * Zero on success, error code on failure.
218 */
219int drm_connector_init(struct drm_device *dev,
220 struct drm_connector *connector,
221 const struct drm_connector_funcs *funcs,
222 int connector_type)
223{
224 struct drm_mode_config *config = &dev->mode_config;
225 int ret;
226 struct ida *connector_ida =
227 &drm_connector_enum_list[connector_type].ida;
228
229 WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
230 (!funcs->atomic_destroy_state ||
231 !funcs->atomic_duplicate_state));
232
233 ret = __drm_mode_object_add(dev, &connector->base,
234 DRM_MODE_OBJECT_CONNECTOR,
235 false, drm_connector_free);
236 if (ret)
237 return ret;
238
239 connector->base.properties = &connector->properties;
240 connector->dev = dev;
241 connector->funcs = funcs;
242
243 /* connector index is used with 32bit bitmasks */
244 ret = ida_simple_get(&config->connector_ida, 0, 32, GFP_KERNEL);
245 if (ret < 0) {
246 DRM_DEBUG_KMS("Failed to allocate %s connector index: %d\n",
247 drm_connector_enum_list[connector_type].name,
248 ret);
249 goto out_put;
250 }
251 connector->index = ret;
252 ret = 0;
253
254 connector->connector_type = connector_type;
255 connector->connector_type_id =
256 ida_simple_get(connector_ida, 1, 0, GFP_KERNEL);
257 if (connector->connector_type_id < 0) {
258 ret = connector->connector_type_id;
259 goto out_put_id;
260 }
261 connector->name =
262 kasprintf(GFP_KERNEL, "%s-%d",
263 drm_connector_enum_list[connector_type].name,
264 connector->connector_type_id);
265 if (!connector->name) {
266 ret = -ENOMEM;
267 goto out_put_type_id;
268 }
269
270 INIT_LIST_HEAD(&connector->probed_modes);
271 INIT_LIST_HEAD(&connector->modes);
272 mutex_init(&connector->mutex);
273 connector->edid_blob_ptr = NULL;
274 connector->epoch_counter = 0;
275 connector->tile_blob_ptr = NULL;
276 connector->status = connector_status_unknown;
277 connector->display_info.panel_orientation =
278 DRM_MODE_PANEL_ORIENTATION_UNKNOWN;
279
280 drm_connector_get_cmdline_mode(connector);
281
282 /* We should add connectors at the end to avoid upsetting the connector
283 * index too much.
284 */
285 spin_lock_irq(&config->connector_list_lock);
286 list_add_tail(&connector->head, &config->connector_list);
287 config->num_connector++;
288 spin_unlock_irq(&config->connector_list_lock);
289
290 if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL &&
291 connector_type != DRM_MODE_CONNECTOR_WRITEBACK)
292 drm_connector_attach_edid_property(connector);
293
294 drm_object_attach_property(&connector->base,
295 config->dpms_property, 0);
296
297 drm_object_attach_property(&connector->base,
298 config->link_status_property,
299 0);
300
301 drm_object_attach_property(&connector->base,
302 config->non_desktop_property,
303 0);
304 drm_object_attach_property(&connector->base,
305 config->tile_property,
306 0);
307
308 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
309 drm_object_attach_property(&connector->base, config->prop_crtc_id, 0);
310 }
311
312 connector->debugfs_entry = NULL;
313out_put_type_id:
314 if (ret)
315 ida_simple_remove(connector_ida, connector->connector_type_id);
316out_put_id:
317 if (ret)
318 ida_simple_remove(&config->connector_ida, connector->index);
319out_put:
320 if (ret)
321 drm_mode_object_unregister(dev, &connector->base);
322
323 return ret;
324}
325EXPORT_SYMBOL(drm_connector_init);
326
327/**
328 * drm_connector_init_with_ddc - Init a preallocated connector
329 * @dev: DRM device
330 * @connector: the connector to init
331 * @funcs: callbacks for this connector
332 * @connector_type: user visible type of the connector
333 * @ddc: pointer to the associated ddc adapter
334 *
335 * Initialises a preallocated connector. Connectors should be
336 * subclassed as part of driver connector objects.
337 *
338 * Ensures that the ddc field of the connector is correctly set.
339 *
340 * Returns:
341 * Zero on success, error code on failure.
342 */
343int drm_connector_init_with_ddc(struct drm_device *dev,
344 struct drm_connector *connector,
345 const struct drm_connector_funcs *funcs,
346 int connector_type,
347 struct i2c_adapter *ddc)
348{
349 int ret;
350
351 ret = drm_connector_init(dev, connector, funcs, connector_type);
352 if (ret)
353 return ret;
354
355 /* provide ddc symlink in sysfs */
356 connector->ddc = ddc;
357
358 return ret;
359}
360EXPORT_SYMBOL(drm_connector_init_with_ddc);
361
362/**
363 * drm_connector_attach_edid_property - attach edid property.
364 * @connector: the connector
365 *
366 * Some connector types like DRM_MODE_CONNECTOR_VIRTUAL do not get a
367 * edid property attached by default. This function can be used to
368 * explicitly enable the edid property in these cases.
369 */
370void drm_connector_attach_edid_property(struct drm_connector *connector)
371{
372 struct drm_mode_config *config = &connector->dev->mode_config;
373
374 drm_object_attach_property(&connector->base,
375 config->edid_property,
376 0);
377}
378EXPORT_SYMBOL(drm_connector_attach_edid_property);
379
380/**
381 * drm_connector_attach_encoder - attach a connector to an encoder
382 * @connector: connector to attach
383 * @encoder: encoder to attach @connector to
384 *
385 * This function links up a connector to an encoder. Note that the routing
386 * restrictions between encoders and crtcs are exposed to userspace through the
387 * possible_clones and possible_crtcs bitmasks.
388 *
389 * Returns:
390 * Zero on success, negative errno on failure.
391 */
392int drm_connector_attach_encoder(struct drm_connector *connector,
393 struct drm_encoder *encoder)
394{
395 /*
396 * In the past, drivers have attempted to model the static association
397 * of connector to encoder in simple connector/encoder devices using a
398 * direct assignment of connector->encoder = encoder. This connection
399 * is a logical one and the responsibility of the core, so drivers are
400 * expected not to mess with this.
401 *
402 * Note that the error return should've been enough here, but a large
403 * majority of drivers ignores the return value, so add in a big WARN
404 * to get people's attention.
405 */
406 if (WARN_ON(connector->encoder))
407 return -EINVAL;
408
409 connector->possible_encoders |= drm_encoder_mask(encoder);
410
411 return 0;
412}
413EXPORT_SYMBOL(drm_connector_attach_encoder);
414
415/**
416 * drm_connector_has_possible_encoder - check if the connector and encoder are
417 * associated with each other
418 * @connector: the connector
419 * @encoder: the encoder
420 *
421 * Returns:
422 * True if @encoder is one of the possible encoders for @connector.
423 */
424bool drm_connector_has_possible_encoder(struct drm_connector *connector,
425 struct drm_encoder *encoder)
426{
427 return connector->possible_encoders & drm_encoder_mask(encoder);
428}
429EXPORT_SYMBOL(drm_connector_has_possible_encoder);
430
431static void drm_mode_remove(struct drm_connector *connector,
432 struct drm_display_mode *mode)
433{
434 list_del(&mode->head);
435 drm_mode_destroy(connector->dev, mode);
436}
437
438/**
439 * drm_connector_cleanup - cleans up an initialised connector
440 * @connector: connector to cleanup
441 *
442 * Cleans up the connector but doesn't free the object.
443 */
444void drm_connector_cleanup(struct drm_connector *connector)
445{
446 struct drm_device *dev = connector->dev;
447 struct drm_display_mode *mode, *t;
448
449 /* The connector should have been removed from userspace long before
450 * it is finally destroyed.
451 */
452 if (WARN_ON(connector->registration_state ==
453 DRM_CONNECTOR_REGISTERED))
454 drm_connector_unregister(connector);
455
456 if (connector->tile_group) {
457 drm_mode_put_tile_group(dev, connector->tile_group);
458 connector->tile_group = NULL;
459 }
460
461 list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
462 drm_mode_remove(connector, mode);
463
464 list_for_each_entry_safe(mode, t, &connector->modes, head)
465 drm_mode_remove(connector, mode);
466
467 ida_simple_remove(&drm_connector_enum_list[connector->connector_type].ida,
468 connector->connector_type_id);
469
470 ida_simple_remove(&dev->mode_config.connector_ida,
471 connector->index);
472
473 kfree(connector->display_info.bus_formats);
474 drm_mode_object_unregister(dev, &connector->base);
475 kfree(connector->name);
476 connector->name = NULL;
477 spin_lock_irq(&dev->mode_config.connector_list_lock);
478 list_del(&connector->head);
479 dev->mode_config.num_connector--;
480 spin_unlock_irq(&dev->mode_config.connector_list_lock);
481
482 WARN_ON(connector->state && !connector->funcs->atomic_destroy_state);
483 if (connector->state && connector->funcs->atomic_destroy_state)
484 connector->funcs->atomic_destroy_state(connector,
485 connector->state);
486
487 mutex_destroy(&connector->mutex);
488
489 memset(connector, 0, sizeof(*connector));
490}
491EXPORT_SYMBOL(drm_connector_cleanup);
492
493/**
494 * drm_connector_register - register a connector
495 * @connector: the connector to register
496 *
497 * Register userspace interfaces for a connector. Only call this for connectors
498 * which can be hotplugged after drm_dev_register() has been called already,
499 * e.g. DP MST connectors. All other connectors will be registered automatically
500 * when calling drm_dev_register().
501 *
502 * Returns:
503 * Zero on success, error code on failure.
504 */
505int drm_connector_register(struct drm_connector *connector)
506{
507 int ret = 0;
508
509 if (!connector->dev->registered)
510 return 0;
511
512 mutex_lock(&connector->mutex);
513 if (connector->registration_state != DRM_CONNECTOR_INITIALIZING)
514 goto unlock;
515
516 ret = drm_sysfs_connector_add(connector);
517 if (ret)
518 goto unlock;
519
520 drm_debugfs_connector_add(connector);
521
522 if (connector->funcs->late_register) {
523 ret = connector->funcs->late_register(connector);
524 if (ret)
525 goto err_debugfs;
526 }
527
528 drm_mode_object_register(connector->dev, &connector->base);
529
530 connector->registration_state = DRM_CONNECTOR_REGISTERED;
531
532 /* Let userspace know we have a new connector */
533 drm_sysfs_hotplug_event(connector->dev);
534
535 goto unlock;
536
537err_debugfs:
538 drm_debugfs_connector_remove(connector);
539 drm_sysfs_connector_remove(connector);
540unlock:
541 mutex_unlock(&connector->mutex);
542 return ret;
543}
544EXPORT_SYMBOL(drm_connector_register);
545
546/**
547 * drm_connector_unregister - unregister a connector
548 * @connector: the connector to unregister
549 *
550 * Unregister userspace interfaces for a connector. Only call this for
551 * connectors which have registered explicitly by calling drm_dev_register(),
552 * since connectors are unregistered automatically when drm_dev_unregister() is
553 * called.
554 */
555void drm_connector_unregister(struct drm_connector *connector)
556{
557 mutex_lock(&connector->mutex);
558 if (connector->registration_state != DRM_CONNECTOR_REGISTERED) {
559 mutex_unlock(&connector->mutex);
560 return;
561 }
562
563 if (connector->funcs->early_unregister)
564 connector->funcs->early_unregister(connector);
565
566 drm_sysfs_connector_remove(connector);
567 drm_debugfs_connector_remove(connector);
568
569 connector->registration_state = DRM_CONNECTOR_UNREGISTERED;
570 mutex_unlock(&connector->mutex);
571}
572EXPORT_SYMBOL(drm_connector_unregister);
573
574void drm_connector_unregister_all(struct drm_device *dev)
575{
576 struct drm_connector *connector;
577 struct drm_connector_list_iter conn_iter;
578
579 drm_connector_list_iter_begin(dev, &conn_iter);
580 drm_for_each_connector_iter(connector, &conn_iter)
581 drm_connector_unregister(connector);
582 drm_connector_list_iter_end(&conn_iter);
583}
584
585int drm_connector_register_all(struct drm_device *dev)
586{
587 struct drm_connector *connector;
588 struct drm_connector_list_iter conn_iter;
589 int ret = 0;
590
591 drm_connector_list_iter_begin(dev, &conn_iter);
592 drm_for_each_connector_iter(connector, &conn_iter) {
593 ret = drm_connector_register(connector);
594 if (ret)
595 break;
596 }
597 drm_connector_list_iter_end(&conn_iter);
598
599 if (ret)
600 drm_connector_unregister_all(dev);
601 return ret;
602}
603
604/**
605 * drm_get_connector_status_name - return a string for connector status
606 * @status: connector status to compute name of
607 *
608 * In contrast to the other drm_get_*_name functions this one here returns a
609 * const pointer and hence is threadsafe.
610 */
611const char *drm_get_connector_status_name(enum drm_connector_status status)
612{
613 if (status == connector_status_connected)
614 return "connected";
615 else if (status == connector_status_disconnected)
616 return "disconnected";
617 else
618 return "unknown";
619}
620EXPORT_SYMBOL(drm_get_connector_status_name);
621
622/**
623 * drm_get_connector_force_name - return a string for connector force
624 * @force: connector force to get name of
625 *
626 * Returns: const pointer to name.
627 */
628const char *drm_get_connector_force_name(enum drm_connector_force force)
629{
630 switch (force) {
631 case DRM_FORCE_UNSPECIFIED:
632 return "unspecified";
633 case DRM_FORCE_OFF:
634 return "off";
635 case DRM_FORCE_ON:
636 return "on";
637 case DRM_FORCE_ON_DIGITAL:
638 return "digital";
639 default:
640 return "unknown";
641 }
642}
643
644#ifdef CONFIG_LOCKDEP
645static struct lockdep_map connector_list_iter_dep_map = {
646 .name = "drm_connector_list_iter"
647};
648#endif
649
650/**
651 * drm_connector_list_iter_begin - initialize a connector_list iterator
652 * @dev: DRM device
653 * @iter: connector_list iterator
654 *
655 * Sets @iter up to walk the &drm_mode_config.connector_list of @dev. @iter
656 * must always be cleaned up again by calling drm_connector_list_iter_end().
657 * Iteration itself happens using drm_connector_list_iter_next() or
658 * drm_for_each_connector_iter().
659 */
660void drm_connector_list_iter_begin(struct drm_device *dev,
661 struct drm_connector_list_iter *iter)
662{
663 iter->dev = dev;
664 iter->conn = NULL;
665 lock_acquire_shared_recursive(&connector_list_iter_dep_map, 0, 1, NULL, _RET_IP_);
666}
667EXPORT_SYMBOL(drm_connector_list_iter_begin);
668
669/*
670 * Extra-safe connector put function that works in any context. Should only be
671 * used from the connector_iter functions, where we never really expect to
672 * actually release the connector when dropping our final reference.
673 */
674static void
675__drm_connector_put_safe(struct drm_connector *conn)
676{
677 struct drm_mode_config *config = &conn->dev->mode_config;
678
679 lockdep_assert_held(&config->connector_list_lock);
680
681 if (!refcount_dec_and_test(&conn->base.refcount.refcount))
682 return;
683
684 llist_add(&conn->free_node, &config->connector_free_list);
685 schedule_work(&config->connector_free_work);
686}
687
688/**
689 * drm_connector_list_iter_next - return next connector
690 * @iter: connector_list iterator
691 *
692 * Returns the next connector for @iter, or NULL when the list walk has
693 * completed.
694 */
695struct drm_connector *
696drm_connector_list_iter_next(struct drm_connector_list_iter *iter)
697{
698 struct drm_connector *old_conn = iter->conn;
699 struct drm_mode_config *config = &iter->dev->mode_config;
700 struct list_head *lhead;
701 unsigned long flags;
702
703 spin_lock_irqsave(&config->connector_list_lock, flags);
704 lhead = old_conn ? &old_conn->head : &config->connector_list;
705
706 do {
707 if (lhead->next == &config->connector_list) {
708 iter->conn = NULL;
709 break;
710 }
711
712 lhead = lhead->next;
713 iter->conn = list_entry(lhead, struct drm_connector, head);
714
715 /* loop until it's not a zombie connector */
716 } while (!kref_get_unless_zero(&iter->conn->base.refcount));
717
718 if (old_conn)
719 __drm_connector_put_safe(old_conn);
720 spin_unlock_irqrestore(&config->connector_list_lock, flags);
721
722 return iter->conn;
723}
724EXPORT_SYMBOL(drm_connector_list_iter_next);
725
726/**
727 * drm_connector_list_iter_end - tear down a connector_list iterator
728 * @iter: connector_list iterator
729 *
730 * Tears down @iter and releases any resources (like &drm_connector references)
731 * acquired while walking the list. This must always be called, both when the
732 * iteration completes fully or when it was aborted without walking the entire
733 * list.
734 */
735void drm_connector_list_iter_end(struct drm_connector_list_iter *iter)
736{
737 struct drm_mode_config *config = &iter->dev->mode_config;
738 unsigned long flags;
739
740 iter->dev = NULL;
741 if (iter->conn) {
742 spin_lock_irqsave(&config->connector_list_lock, flags);
743 __drm_connector_put_safe(iter->conn);
744 spin_unlock_irqrestore(&config->connector_list_lock, flags);
745 }
746 lock_release(&connector_list_iter_dep_map, _RET_IP_);
747}
748EXPORT_SYMBOL(drm_connector_list_iter_end);
749
750static const struct drm_prop_enum_list drm_subpixel_enum_list[] = {
751 { SubPixelUnknown, "Unknown" },
752 { SubPixelHorizontalRGB, "Horizontal RGB" },
753 { SubPixelHorizontalBGR, "Horizontal BGR" },
754 { SubPixelVerticalRGB, "Vertical RGB" },
755 { SubPixelVerticalBGR, "Vertical BGR" },
756 { SubPixelNone, "None" },
757};
758
759/**
760 * drm_get_subpixel_order_name - return a string for a given subpixel enum
761 * @order: enum of subpixel_order
762 *
763 * Note you could abuse this and return something out of bounds, but that
764 * would be a caller error. No unscrubbed user data should make it here.
765 */
766const char *drm_get_subpixel_order_name(enum subpixel_order order)
767{
768 return drm_subpixel_enum_list[order].name;
769}
770EXPORT_SYMBOL(drm_get_subpixel_order_name);
771
772static const struct drm_prop_enum_list drm_dpms_enum_list[] = {
773 { DRM_MODE_DPMS_ON, "On" },
774 { DRM_MODE_DPMS_STANDBY, "Standby" },
775 { DRM_MODE_DPMS_SUSPEND, "Suspend" },
776 { DRM_MODE_DPMS_OFF, "Off" }
777};
778DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)
779
780static const struct drm_prop_enum_list drm_link_status_enum_list[] = {
781 { DRM_MODE_LINK_STATUS_GOOD, "Good" },
782 { DRM_MODE_LINK_STATUS_BAD, "Bad" },
783};
784
785/**
786 * drm_display_info_set_bus_formats - set the supported bus formats
787 * @info: display info to store bus formats in
788 * @formats: array containing the supported bus formats
789 * @num_formats: the number of entries in the fmts array
790 *
791 * Store the supported bus formats in display info structure.
792 * See MEDIA_BUS_FMT_* definitions in include/uapi/linux/media-bus-format.h for
793 * a full list of available formats.
794 */
795int drm_display_info_set_bus_formats(struct drm_display_info *info,
796 const u32 *formats,
797 unsigned int num_formats)
798{
799 u32 *fmts = NULL;
800
801 if (!formats && num_formats)
802 return -EINVAL;
803
804 if (formats && num_formats) {
805 fmts = kmemdup(formats, sizeof(*formats) * num_formats,
806 GFP_KERNEL);
807 if (!fmts)
808 return -ENOMEM;
809 }
810
811 kfree(info->bus_formats);
812 info->bus_formats = fmts;
813 info->num_bus_formats = num_formats;
814
815 return 0;
816}
817EXPORT_SYMBOL(drm_display_info_set_bus_formats);
818
819/* Optional connector properties. */
820static const struct drm_prop_enum_list drm_scaling_mode_enum_list[] = {
821 { DRM_MODE_SCALE_NONE, "None" },
822 { DRM_MODE_SCALE_FULLSCREEN, "Full" },
823 { DRM_MODE_SCALE_CENTER, "Center" },
824 { DRM_MODE_SCALE_ASPECT, "Full aspect" },
825};
826
827static const struct drm_prop_enum_list drm_aspect_ratio_enum_list[] = {
828 { DRM_MODE_PICTURE_ASPECT_NONE, "Automatic" },
829 { DRM_MODE_PICTURE_ASPECT_4_3, "4:3" },
830 { DRM_MODE_PICTURE_ASPECT_16_9, "16:9" },
831};
832
833static const struct drm_prop_enum_list drm_content_type_enum_list[] = {
834 { DRM_MODE_CONTENT_TYPE_NO_DATA, "No Data" },
835 { DRM_MODE_CONTENT_TYPE_GRAPHICS, "Graphics" },
836 { DRM_MODE_CONTENT_TYPE_PHOTO, "Photo" },
837 { DRM_MODE_CONTENT_TYPE_CINEMA, "Cinema" },
838 { DRM_MODE_CONTENT_TYPE_GAME, "Game" },
839};
840
841static const struct drm_prop_enum_list drm_panel_orientation_enum_list[] = {
842 { DRM_MODE_PANEL_ORIENTATION_NORMAL, "Normal" },
843 { DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP, "Upside Down" },
844 { DRM_MODE_PANEL_ORIENTATION_LEFT_UP, "Left Side Up" },
845 { DRM_MODE_PANEL_ORIENTATION_RIGHT_UP, "Right Side Up" },
846};
847
848static const struct drm_prop_enum_list drm_dvi_i_select_enum_list[] = {
849 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
850 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
851 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
852};
853DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)
854
855static const struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] = {
856 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
857 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DVI-I */
858 { DRM_MODE_SUBCONNECTOR_DVIA, "DVI-A" }, /* DVI-I */
859};
860DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
861 drm_dvi_i_subconnector_enum_list)
862
863static const struct drm_prop_enum_list drm_tv_select_enum_list[] = {
864 { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
865 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
866 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
867 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
868 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
869};
870DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)
871
872static const struct drm_prop_enum_list drm_tv_subconnector_enum_list[] = {
873 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
874 { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
875 { DRM_MODE_SUBCONNECTOR_SVIDEO, "SVIDEO" }, /* TV-out */
876 { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
877 { DRM_MODE_SUBCONNECTOR_SCART, "SCART" }, /* TV-out */
878};
879DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
880 drm_tv_subconnector_enum_list)
881
882static const struct drm_prop_enum_list drm_dp_subconnector_enum_list[] = {
883 { DRM_MODE_SUBCONNECTOR_Unknown, "Unknown" }, /* DVI-I, TV-out and DP */
884 { DRM_MODE_SUBCONNECTOR_VGA, "VGA" }, /* DP */
885 { DRM_MODE_SUBCONNECTOR_DVID, "DVI-D" }, /* DP */
886 { DRM_MODE_SUBCONNECTOR_HDMIA, "HDMI" }, /* DP */
887 { DRM_MODE_SUBCONNECTOR_DisplayPort, "DP" }, /* DP */
888 { DRM_MODE_SUBCONNECTOR_Wireless, "Wireless" }, /* DP */
889 { DRM_MODE_SUBCONNECTOR_Native, "Native" }, /* DP */
890};
891
892DRM_ENUM_NAME_FN(drm_get_dp_subconnector_name,
893 drm_dp_subconnector_enum_list)
894
895static const struct drm_prop_enum_list hdmi_colorspaces[] = {
896 /* For Default case, driver will set the colorspace */
897 { DRM_MODE_COLORIMETRY_DEFAULT, "Default" },
898 /* Standard Definition Colorimetry based on CEA 861 */
899 { DRM_MODE_COLORIMETRY_SMPTE_170M_YCC, "SMPTE_170M_YCC" },
900 { DRM_MODE_COLORIMETRY_BT709_YCC, "BT709_YCC" },
901 /* Standard Definition Colorimetry based on IEC 61966-2-4 */
902 { DRM_MODE_COLORIMETRY_XVYCC_601, "XVYCC_601" },
903 /* High Definition Colorimetry based on IEC 61966-2-4 */
904 { DRM_MODE_COLORIMETRY_XVYCC_709, "XVYCC_709" },
905 /* Colorimetry based on IEC 61966-2-1/Amendment 1 */
906 { DRM_MODE_COLORIMETRY_SYCC_601, "SYCC_601" },
907 /* Colorimetry based on IEC 61966-2-5 [33] */
908 { DRM_MODE_COLORIMETRY_OPYCC_601, "opYCC_601" },
909 /* Colorimetry based on IEC 61966-2-5 */
910 { DRM_MODE_COLORIMETRY_OPRGB, "opRGB" },
911 /* Colorimetry based on ITU-R BT.2020 */
912 { DRM_MODE_COLORIMETRY_BT2020_CYCC, "BT2020_CYCC" },
913 /* Colorimetry based on ITU-R BT.2020 */
914 { DRM_MODE_COLORIMETRY_BT2020_RGB, "BT2020_RGB" },
915 /* Colorimetry based on ITU-R BT.2020 */
916 { DRM_MODE_COLORIMETRY_BT2020_YCC, "BT2020_YCC" },
917 /* Added as part of Additional Colorimetry Extension in 861.G */
918 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65, "DCI-P3_RGB_D65" },
919 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER, "DCI-P3_RGB_Theater" },
920};
921
922/*
923 * As per DP 1.4a spec, 2.2.5.7.5 VSC SDP Payload for Pixel Encoding/Colorimetry
924 * Format Table 2-120
925 */
926static const struct drm_prop_enum_list dp_colorspaces[] = {
927 /* For Default case, driver will set the colorspace */
928 { DRM_MODE_COLORIMETRY_DEFAULT, "Default" },
929 { DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED, "RGB_Wide_Gamut_Fixed_Point" },
930 /* Colorimetry based on scRGB (IEC 61966-2-2) */
931 { DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT, "RGB_Wide_Gamut_Floating_Point" },
932 /* Colorimetry based on IEC 61966-2-5 */
933 { DRM_MODE_COLORIMETRY_OPRGB, "opRGB" },
934 /* Colorimetry based on SMPTE RP 431-2 */
935 { DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65, "DCI-P3_RGB_D65" },
936 /* Colorimetry based on ITU-R BT.2020 */
937 { DRM_MODE_COLORIMETRY_BT2020_RGB, "BT2020_RGB" },
938 { DRM_MODE_COLORIMETRY_BT601_YCC, "BT601_YCC" },
939 { DRM_MODE_COLORIMETRY_BT709_YCC, "BT709_YCC" },
940 /* Standard Definition Colorimetry based on IEC 61966-2-4 */
941 { DRM_MODE_COLORIMETRY_XVYCC_601, "XVYCC_601" },
942 /* High Definition Colorimetry based on IEC 61966-2-4 */
943 { DRM_MODE_COLORIMETRY_XVYCC_709, "XVYCC_709" },
944 /* Colorimetry based on IEC 61966-2-1/Amendment 1 */
945 { DRM_MODE_COLORIMETRY_SYCC_601, "SYCC_601" },
946 /* Colorimetry based on IEC 61966-2-5 [33] */
947 { DRM_MODE_COLORIMETRY_OPYCC_601, "opYCC_601" },
948 /* Colorimetry based on ITU-R BT.2020 */
949 { DRM_MODE_COLORIMETRY_BT2020_CYCC, "BT2020_CYCC" },
950 /* Colorimetry based on ITU-R BT.2020 */
951 { DRM_MODE_COLORIMETRY_BT2020_YCC, "BT2020_YCC" },
952};
953
954/**
955 * DOC: standard connector properties
956 *
957 * DRM connectors have a few standardized properties:
958 *
959 * EDID:
960 * Blob property which contains the current EDID read from the sink. This
961 * is useful to parse sink identification information like vendor, model
962 * and serial. Drivers should update this property by calling
963 * drm_connector_update_edid_property(), usually after having parsed
964 * the EDID using drm_add_edid_modes(). Userspace cannot change this
965 * property.
966 *
967 * User-space should not parse the EDID to obtain information exposed via
968 * other KMS properties (because the kernel might apply limits, quirks or
969 * fixups to the EDID). For instance, user-space should not try to parse
970 * mode lists from the EDID.
971 * DPMS:
972 * Legacy property for setting the power state of the connector. For atomic
973 * drivers this is only provided for backwards compatibility with existing
974 * drivers, it remaps to controlling the "ACTIVE" property on the CRTC the
975 * connector is linked to. Drivers should never set this property directly,
976 * it is handled by the DRM core by calling the &drm_connector_funcs.dpms
977 * callback. For atomic drivers the remapping to the "ACTIVE" property is
978 * implemented in the DRM core.
979 *
980 * Note that this property cannot be set through the MODE_ATOMIC ioctl,
981 * userspace must use "ACTIVE" on the CRTC instead.
982 *
983 * WARNING:
984 *
985 * For userspace also running on legacy drivers the "DPMS" semantics are a
986 * lot more complicated. First, userspace cannot rely on the "DPMS" value
987 * returned by the GETCONNECTOR actually reflecting reality, because many
988 * drivers fail to update it. For atomic drivers this is taken care of in
989 * drm_atomic_helper_update_legacy_modeset_state().
990 *
991 * The second issue is that the DPMS state is only well-defined when the
992 * connector is connected to a CRTC. In atomic the DRM core enforces that
993 * "ACTIVE" is off in such a case, no such checks exists for "DPMS".
994 *
995 * Finally, when enabling an output using the legacy SETCONFIG ioctl then
996 * "DPMS" is forced to ON. But see above, that might not be reflected in
997 * the software value on legacy drivers.
998 *
999 * Summarizing: Only set "DPMS" when the connector is known to be enabled,
1000 * assume that a successful SETCONFIG call also sets "DPMS" to on, and
1001 * never read back the value of "DPMS" because it can be incorrect.
1002 * PATH:
1003 * Connector path property to identify how this sink is physically
1004 * connected. Used by DP MST. This should be set by calling
1005 * drm_connector_set_path_property(), in the case of DP MST with the
1006 * path property the MST manager created. Userspace cannot change this
1007 * property.
1008 * TILE:
1009 * Connector tile group property to indicate how a set of DRM connector
1010 * compose together into one logical screen. This is used by both high-res
1011 * external screens (often only using a single cable, but exposing multiple
1012 * DP MST sinks), or high-res integrated panels (like dual-link DSI) which
1013 * are not gen-locked. Note that for tiled panels which are genlocked, like
1014 * dual-link LVDS or dual-link DSI, the driver should try to not expose the
1015 * tiling and virtualise both &drm_crtc and &drm_plane if needed. Drivers
1016 * should update this value using drm_connector_set_tile_property().
1017 * Userspace cannot change this property.
1018 * link-status:
1019 * Connector link-status property to indicate the status of link. The
1020 * default value of link-status is "GOOD". If something fails during or
1021 * after modeset, the kernel driver may set this to "BAD" and issue a
1022 * hotplug uevent. Drivers should update this value using
1023 * drm_connector_set_link_status_property().
1024 *
1025 * When user-space receives the hotplug uevent and detects a "BAD"
1026 * link-status, the sink doesn't receive pixels anymore (e.g. the screen
1027 * becomes completely black). The list of available modes may have
1028 * changed. User-space is expected to pick a new mode if the current one
1029 * has disappeared and perform a new modeset with link-status set to
1030 * "GOOD" to re-enable the connector.
1031 *
1032 * If multiple connectors share the same CRTC and one of them gets a "BAD"
1033 * link-status, the other are unaffected (ie. the sinks still continue to
1034 * receive pixels).
1035 *
1036 * When user-space performs an atomic commit on a connector with a "BAD"
1037 * link-status without resetting the property to "GOOD", the sink may
1038 * still not receive pixels. When user-space performs an atomic commit
1039 * which resets the link-status property to "GOOD" without the
1040 * ALLOW_MODESET flag set, it might fail because a modeset is required.
1041 *
1042 * User-space can only change link-status to "GOOD", changing it to "BAD"
1043 * is a no-op.
1044 *
1045 * For backwards compatibility with non-atomic userspace the kernel
1046 * tries to automatically set the link-status back to "GOOD" in the
1047 * SETCRTC IOCTL. This might fail if the mode is no longer valid, similar
1048 * to how it might fail if a different screen has been connected in the
1049 * interim.
1050 * non_desktop:
1051 * Indicates the output should be ignored for purposes of displaying a
1052 * standard desktop environment or console. This is most likely because
1053 * the output device is not rectilinear.
1054 * Content Protection:
1055 * This property is used by userspace to request the kernel protect future
1056 * content communicated over the link. When requested, kernel will apply
1057 * the appropriate means of protection (most often HDCP), and use the
1058 * property to tell userspace the protection is active.
1059 *
1060 * Drivers can set this up by calling
1061 * drm_connector_attach_content_protection_property() on initialization.
1062 *
1063 * The value of this property can be one of the following:
1064 *
1065 * DRM_MODE_CONTENT_PROTECTION_UNDESIRED = 0
1066 * The link is not protected, content is transmitted in the clear.
1067 * DRM_MODE_CONTENT_PROTECTION_DESIRED = 1
1068 * Userspace has requested content protection, but the link is not
1069 * currently protected. When in this state, kernel should enable
1070 * Content Protection as soon as possible.
1071 * DRM_MODE_CONTENT_PROTECTION_ENABLED = 2
1072 * Userspace has requested content protection, and the link is
1073 * protected. Only the driver can set the property to this value.
1074 * If userspace attempts to set to ENABLED, kernel will return
1075 * -EINVAL.
1076 *
1077 * A few guidelines:
1078 *
1079 * - DESIRED state should be preserved until userspace de-asserts it by
1080 * setting the property to UNDESIRED. This means ENABLED should only
1081 * transition to UNDESIRED when the user explicitly requests it.
1082 * - If the state is DESIRED, kernel should attempt to re-authenticate the
1083 * link whenever possible. This includes across disable/enable, dpms,
1084 * hotplug, downstream device changes, link status failures, etc..
1085 * - Kernel sends uevent with the connector id and property id through
1086 * @drm_hdcp_update_content_protection, upon below kernel triggered
1087 * scenarios:
1088 *
1089 * - DESIRED -> ENABLED (authentication success)
1090 * - ENABLED -> DESIRED (termination of authentication)
1091 * - Please note no uevents for userspace triggered property state changes,
1092 * which can't fail such as
1093 *
1094 * - DESIRED/ENABLED -> UNDESIRED
1095 * - UNDESIRED -> DESIRED
1096 * - Userspace is responsible for polling the property or listen to uevents
1097 * to determine when the value transitions from ENABLED to DESIRED.
1098 * This signifies the link is no longer protected and userspace should
1099 * take appropriate action (whatever that might be).
1100 *
1101 * HDCP Content Type:
1102 * This Enum property is used by the userspace to declare the content type
1103 * of the display stream, to kernel. Here display stream stands for any
1104 * display content that userspace intended to display through HDCP
1105 * encryption.
1106 *
1107 * Content Type of a stream is decided by the owner of the stream, as
1108 * "HDCP Type0" or "HDCP Type1".
1109 *
1110 * The value of the property can be one of the below:
1111 * - "HDCP Type0": DRM_MODE_HDCP_CONTENT_TYPE0 = 0
1112 * - "HDCP Type1": DRM_MODE_HDCP_CONTENT_TYPE1 = 1
1113 *
1114 * When kernel starts the HDCP authentication (see "Content Protection"
1115 * for details), it uses the content type in "HDCP Content Type"
1116 * for performing the HDCP authentication with the display sink.
1117 *
1118 * Please note in HDCP spec versions, a link can be authenticated with
1119 * HDCP 2.2 for Content Type 0/Content Type 1. Where as a link can be
1120 * authenticated with HDCP1.4 only for Content Type 0(though it is implicit
1121 * in nature. As there is no reference for Content Type in HDCP1.4).
1122 *
1123 * HDCP2.2 authentication protocol itself takes the "Content Type" as a
1124 * parameter, which is a input for the DP HDCP2.2 encryption algo.
1125 *
1126 * In case of Type 0 content protection request, kernel driver can choose
1127 * either of HDCP spec versions 1.4 and 2.2. When HDCP2.2 is used for
1128 * "HDCP Type 0", a HDCP 2.2 capable repeater in the downstream can send
1129 * that content to a HDCP 1.4 authenticated HDCP sink (Type0 link).
1130 * But if the content is classified as "HDCP Type 1", above mentioned
1131 * HDCP 2.2 repeater wont send the content to the HDCP sink as it can't
1132 * authenticate the HDCP1.4 capable sink for "HDCP Type 1".
1133 *
1134 * Please note userspace can be ignorant of the HDCP versions used by the
1135 * kernel driver to achieve the "HDCP Content Type".
1136 *
1137 * At current scenario, classifying a content as Type 1 ensures that the
1138 * content will be displayed only through the HDCP2.2 encrypted link.
1139 *
1140 * Note that the HDCP Content Type property is introduced at HDCP 2.2, and
1141 * defaults to type 0. It is only exposed by drivers supporting HDCP 2.2
1142 * (hence supporting Type 0 and Type 1). Based on how next versions of
1143 * HDCP specs are defined content Type could be used for higher versions
1144 * too.
1145 *
1146 * If content type is changed when "Content Protection" is not UNDESIRED,
1147 * then kernel will disable the HDCP and re-enable with new type in the
1148 * same atomic commit. And when "Content Protection" is ENABLED, it means
1149 * that link is HDCP authenticated and encrypted, for the transmission of
1150 * the Type of stream mentioned at "HDCP Content Type".
1151 *
1152 * HDR_OUTPUT_METADATA:
1153 * Connector property to enable userspace to send HDR Metadata to
1154 * driver. This metadata is based on the composition and blending
1155 * policies decided by user, taking into account the hardware and
1156 * sink capabilities. The driver gets this metadata and creates a
1157 * Dynamic Range and Mastering Infoframe (DRM) in case of HDMI,
1158 * SDP packet (Non-audio INFOFRAME SDP v1.3) for DP. This is then
1159 * sent to sink. This notifies the sink of the upcoming frame's Color
1160 * Encoding and Luminance parameters.
1161 *
1162 * Userspace first need to detect the HDR capabilities of sink by
1163 * reading and parsing the EDID. Details of HDR metadata for HDMI
1164 * are added in CTA 861.G spec. For DP , its defined in VESA DP
1165 * Standard v1.4. It needs to then get the metadata information
1166 * of the video/game/app content which are encoded in HDR (basically
1167 * using HDR transfer functions). With this information it needs to
1168 * decide on a blending policy and compose the relevant
1169 * layers/overlays into a common format. Once this blending is done,
1170 * userspace will be aware of the metadata of the composed frame to
1171 * be send to sink. It then uses this property to communicate this
1172 * metadata to driver which then make a Infoframe packet and sends
1173 * to sink based on the type of encoder connected.
1174 *
1175 * Userspace will be responsible to do Tone mapping operation in case:
1176 * - Some layers are HDR and others are SDR
1177 * - HDR layers luminance is not same as sink
1178 *
1179 * It will even need to do colorspace conversion and get all layers
1180 * to one common colorspace for blending. It can use either GL, Media
1181 * or display engine to get this done based on the capabilities of the
1182 * associated hardware.
1183 *
1184 * Driver expects metadata to be put in &struct hdr_output_metadata
1185 * structure from userspace. This is received as blob and stored in
1186 * &drm_connector_state.hdr_output_metadata. It parses EDID and saves the
1187 * sink metadata in &struct hdr_sink_metadata, as
1188 * &drm_connector.hdr_sink_metadata. Driver uses
1189 * drm_hdmi_infoframe_set_hdr_metadata() helper to set the HDR metadata,
1190 * hdmi_drm_infoframe_pack() to pack the infoframe as per spec, in case of
1191 * HDMI encoder.
1192 *
1193 * max bpc:
1194 * This range property is used by userspace to limit the bit depth. When
1195 * used the driver would limit the bpc in accordance with the valid range
1196 * supported by the hardware and sink. Drivers to use the function
1197 * drm_connector_attach_max_bpc_property() to create and attach the
1198 * property to the connector during initialization.
1199 *
1200 * Connectors also have one standardized atomic property:
1201 *
1202 * CRTC_ID:
1203 * Mode object ID of the &drm_crtc this connector should be connected to.
1204 *
1205 * Connectors for LCD panels may also have one standardized property:
1206 *
1207 * panel orientation:
1208 * On some devices the LCD panel is mounted in the casing in such a way
1209 * that the up/top side of the panel does not match with the top side of
1210 * the device. Userspace can use this property to check for this.
1211 * Note that input coordinates from touchscreens (input devices with
1212 * INPUT_PROP_DIRECT) will still map 1:1 to the actual LCD panel
1213 * coordinates, so if userspace rotates the picture to adjust for
1214 * the orientation it must also apply the same transformation to the
1215 * touchscreen input coordinates. This property is initialized by calling
1216 * drm_connector_set_panel_orientation() or
1217 * drm_connector_set_panel_orientation_with_quirk()
1218 *
1219 * scaling mode:
1220 * This property defines how a non-native mode is upscaled to the native
1221 * mode of an LCD panel:
1222 *
1223 * None:
1224 * No upscaling happens, scaling is left to the panel. Not all
1225 * drivers expose this mode.
1226 * Full:
1227 * The output is upscaled to the full resolution of the panel,
1228 * ignoring the aspect ratio.
1229 * Center:
1230 * No upscaling happens, the output is centered within the native
1231 * resolution the panel.
1232 * Full aspect:
1233 * The output is upscaled to maximize either the width or height
1234 * while retaining the aspect ratio.
1235 *
1236 * This property should be set up by calling
1237 * drm_connector_attach_scaling_mode_property(). Note that drivers
1238 * can also expose this property to external outputs, in which case they
1239 * must support "None", which should be the default (since external screens
1240 * have a built-in scaler).
1241 *
1242 * subconnector:
1243 * This property is used by DVI-I, TVout and DisplayPort to indicate different
1244 * connector subtypes. Enum values more or less match with those from main
1245 * connector types.
1246 * For DVI-I and TVout there is also a matching property "select subconnector"
1247 * allowing to switch between signal types.
1248 * DP subconnector corresponds to a downstream port.
1249 */
1250
1251int drm_connector_create_standard_properties(struct drm_device *dev)
1252{
1253 struct drm_property *prop;
1254
1255 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB |
1256 DRM_MODE_PROP_IMMUTABLE,
1257 "EDID", 0);
1258 if (!prop)
1259 return -ENOMEM;
1260 dev->mode_config.edid_property = prop;
1261
1262 prop = drm_property_create_enum(dev, 0,
1263 "DPMS", drm_dpms_enum_list,
1264 ARRAY_SIZE(drm_dpms_enum_list));
1265 if (!prop)
1266 return -ENOMEM;
1267 dev->mode_config.dpms_property = prop;
1268
1269 prop = drm_property_create(dev,
1270 DRM_MODE_PROP_BLOB |
1271 DRM_MODE_PROP_IMMUTABLE,
1272 "PATH", 0);
1273 if (!prop)
1274 return -ENOMEM;
1275 dev->mode_config.path_property = prop;
1276
1277 prop = drm_property_create(dev,
1278 DRM_MODE_PROP_BLOB |
1279 DRM_MODE_PROP_IMMUTABLE,
1280 "TILE", 0);
1281 if (!prop)
1282 return -ENOMEM;
1283 dev->mode_config.tile_property = prop;
1284
1285 prop = drm_property_create_enum(dev, 0, "link-status",
1286 drm_link_status_enum_list,
1287 ARRAY_SIZE(drm_link_status_enum_list));
1288 if (!prop)
1289 return -ENOMEM;
1290 dev->mode_config.link_status_property = prop;
1291
1292 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE, "non-desktop");
1293 if (!prop)
1294 return -ENOMEM;
1295 dev->mode_config.non_desktop_property = prop;
1296
1297 prop = drm_property_create(dev, DRM_MODE_PROP_BLOB,
1298 "HDR_OUTPUT_METADATA", 0);
1299 if (!prop)
1300 return -ENOMEM;
1301 dev->mode_config.hdr_output_metadata_property = prop;
1302
1303 return 0;
1304}
1305
1306/**
1307 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
1308 * @dev: DRM device
1309 *
1310 * Called by a driver the first time a DVI-I connector is made.
1311 */
1312int drm_mode_create_dvi_i_properties(struct drm_device *dev)
1313{
1314 struct drm_property *dvi_i_selector;
1315 struct drm_property *dvi_i_subconnector;
1316
1317 if (dev->mode_config.dvi_i_select_subconnector_property)
1318 return 0;
1319
1320 dvi_i_selector =
1321 drm_property_create_enum(dev, 0,
1322 "select subconnector",
1323 drm_dvi_i_select_enum_list,
1324 ARRAY_SIZE(drm_dvi_i_select_enum_list));
1325 dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;
1326
1327 dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1328 "subconnector",
1329 drm_dvi_i_subconnector_enum_list,
1330 ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
1331 dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;
1332
1333 return 0;
1334}
1335EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);
1336
1337/**
1338 * drm_connector_attach_dp_subconnector_property - create subconnector property for DP
1339 * @connector: drm_connector to attach property
1340 *
1341 * Called by a driver when DP connector is created.
1342 */
1343void drm_connector_attach_dp_subconnector_property(struct drm_connector *connector)
1344{
1345 struct drm_mode_config *mode_config = &connector->dev->mode_config;
1346
1347 if (!mode_config->dp_subconnector_property)
1348 mode_config->dp_subconnector_property =
1349 drm_property_create_enum(connector->dev,
1350 DRM_MODE_PROP_IMMUTABLE,
1351 "subconnector",
1352 drm_dp_subconnector_enum_list,
1353 ARRAY_SIZE(drm_dp_subconnector_enum_list));
1354
1355 drm_object_attach_property(&connector->base,
1356 mode_config->dp_subconnector_property,
1357 DRM_MODE_SUBCONNECTOR_Unknown);
1358}
1359EXPORT_SYMBOL(drm_connector_attach_dp_subconnector_property);
1360
1361/**
1362 * DOC: HDMI connector properties
1363 *
1364 * content type (HDMI specific):
1365 * Indicates content type setting to be used in HDMI infoframes to indicate
1366 * content type for the external device, so that it adjusts its display
1367 * settings accordingly.
1368 *
1369 * The value of this property can be one of the following:
1370 *
1371 * No Data:
1372 * Content type is unknown
1373 * Graphics:
1374 * Content type is graphics
1375 * Photo:
1376 * Content type is photo
1377 * Cinema:
1378 * Content type is cinema
1379 * Game:
1380 * Content type is game
1381 *
1382 * Drivers can set up this property by calling
1383 * drm_connector_attach_content_type_property(). Decoding to
1384 * infoframe values is done through drm_hdmi_avi_infoframe_content_type().
1385 */
1386
1387/**
1388 * drm_connector_attach_content_type_property - attach content-type property
1389 * @connector: connector to attach content type property on.
1390 *
1391 * Called by a driver the first time a HDMI connector is made.
1392 */
1393int drm_connector_attach_content_type_property(struct drm_connector *connector)
1394{
1395 if (!drm_mode_create_content_type_property(connector->dev))
1396 drm_object_attach_property(&connector->base,
1397 connector->dev->mode_config.content_type_property,
1398 DRM_MODE_CONTENT_TYPE_NO_DATA);
1399 return 0;
1400}
1401EXPORT_SYMBOL(drm_connector_attach_content_type_property);
1402
1403
1404/**
1405 * drm_hdmi_avi_infoframe_content_type() - fill the HDMI AVI infoframe
1406 * content type information, based
1407 * on correspondent DRM property.
1408 * @frame: HDMI AVI infoframe
1409 * @conn_state: DRM display connector state
1410 *
1411 */
1412void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
1413 const struct drm_connector_state *conn_state)
1414{
1415 switch (conn_state->content_type) {
1416 case DRM_MODE_CONTENT_TYPE_GRAPHICS:
1417 frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1418 break;
1419 case DRM_MODE_CONTENT_TYPE_CINEMA:
1420 frame->content_type = HDMI_CONTENT_TYPE_CINEMA;
1421 break;
1422 case DRM_MODE_CONTENT_TYPE_GAME:
1423 frame->content_type = HDMI_CONTENT_TYPE_GAME;
1424 break;
1425 case DRM_MODE_CONTENT_TYPE_PHOTO:
1426 frame->content_type = HDMI_CONTENT_TYPE_PHOTO;
1427 break;
1428 default:
1429 /* Graphics is the default(0) */
1430 frame->content_type = HDMI_CONTENT_TYPE_GRAPHICS;
1431 }
1432
1433 frame->itc = conn_state->content_type != DRM_MODE_CONTENT_TYPE_NO_DATA;
1434}
1435EXPORT_SYMBOL(drm_hdmi_avi_infoframe_content_type);
1436
1437/**
1438 * drm_connector_attach_tv_margin_properties - attach TV connector margin
1439 * properties
1440 * @connector: DRM connector
1441 *
1442 * Called by a driver when it needs to attach TV margin props to a connector.
1443 * Typically used on SDTV and HDMI connectors.
1444 */
1445void drm_connector_attach_tv_margin_properties(struct drm_connector *connector)
1446{
1447 struct drm_device *dev = connector->dev;
1448
1449 drm_object_attach_property(&connector->base,
1450 dev->mode_config.tv_left_margin_property,
1451 0);
1452 drm_object_attach_property(&connector->base,
1453 dev->mode_config.tv_right_margin_property,
1454 0);
1455 drm_object_attach_property(&connector->base,
1456 dev->mode_config.tv_top_margin_property,
1457 0);
1458 drm_object_attach_property(&connector->base,
1459 dev->mode_config.tv_bottom_margin_property,
1460 0);
1461}
1462EXPORT_SYMBOL(drm_connector_attach_tv_margin_properties);
1463
1464/**
1465 * drm_mode_create_tv_margin_properties - create TV connector margin properties
1466 * @dev: DRM device
1467 *
1468 * Called by a driver's HDMI connector initialization routine, this function
1469 * creates the TV margin properties for a given device. No need to call this
1470 * function for an SDTV connector, it's already called from
1471 * drm_mode_create_tv_properties().
1472 */
1473int drm_mode_create_tv_margin_properties(struct drm_device *dev)
1474{
1475 if (dev->mode_config.tv_left_margin_property)
1476 return 0;
1477
1478 dev->mode_config.tv_left_margin_property =
1479 drm_property_create_range(dev, 0, "left margin", 0, 100);
1480 if (!dev->mode_config.tv_left_margin_property)
1481 return -ENOMEM;
1482
1483 dev->mode_config.tv_right_margin_property =
1484 drm_property_create_range(dev, 0, "right margin", 0, 100);
1485 if (!dev->mode_config.tv_right_margin_property)
1486 return -ENOMEM;
1487
1488 dev->mode_config.tv_top_margin_property =
1489 drm_property_create_range(dev, 0, "top margin", 0, 100);
1490 if (!dev->mode_config.tv_top_margin_property)
1491 return -ENOMEM;
1492
1493 dev->mode_config.tv_bottom_margin_property =
1494 drm_property_create_range(dev, 0, "bottom margin", 0, 100);
1495 if (!dev->mode_config.tv_bottom_margin_property)
1496 return -ENOMEM;
1497
1498 return 0;
1499}
1500EXPORT_SYMBOL(drm_mode_create_tv_margin_properties);
1501
1502/**
1503 * drm_mode_create_tv_properties - create TV specific connector properties
1504 * @dev: DRM device
1505 * @num_modes: number of different TV formats (modes) supported
1506 * @modes: array of pointers to strings containing name of each format
1507 *
1508 * Called by a driver's TV initialization routine, this function creates
1509 * the TV specific connector properties for a given device. Caller is
1510 * responsible for allocating a list of format names and passing them to
1511 * this routine.
1512 */
1513int drm_mode_create_tv_properties(struct drm_device *dev,
1514 unsigned int num_modes,
1515 const char * const modes[])
1516{
1517 struct drm_property *tv_selector;
1518 struct drm_property *tv_subconnector;
1519 unsigned int i;
1520
1521 if (dev->mode_config.tv_select_subconnector_property)
1522 return 0;
1523
1524 /*
1525 * Basic connector properties
1526 */
1527 tv_selector = drm_property_create_enum(dev, 0,
1528 "select subconnector",
1529 drm_tv_select_enum_list,
1530 ARRAY_SIZE(drm_tv_select_enum_list));
1531 if (!tv_selector)
1532 goto nomem;
1533
1534 dev->mode_config.tv_select_subconnector_property = tv_selector;
1535
1536 tv_subconnector =
1537 drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
1538 "subconnector",
1539 drm_tv_subconnector_enum_list,
1540 ARRAY_SIZE(drm_tv_subconnector_enum_list));
1541 if (!tv_subconnector)
1542 goto nomem;
1543 dev->mode_config.tv_subconnector_property = tv_subconnector;
1544
1545 /*
1546 * Other, TV specific properties: margins & TV modes.
1547 */
1548 if (drm_mode_create_tv_margin_properties(dev))
1549 goto nomem;
1550
1551 dev->mode_config.tv_mode_property =
1552 drm_property_create(dev, DRM_MODE_PROP_ENUM,
1553 "mode", num_modes);
1554 if (!dev->mode_config.tv_mode_property)
1555 goto nomem;
1556
1557 for (i = 0; i < num_modes; i++)
1558 drm_property_add_enum(dev->mode_config.tv_mode_property,
1559 i, modes[i]);
1560
1561 dev->mode_config.tv_brightness_property =
1562 drm_property_create_range(dev, 0, "brightness", 0, 100);
1563 if (!dev->mode_config.tv_brightness_property)
1564 goto nomem;
1565
1566 dev->mode_config.tv_contrast_property =
1567 drm_property_create_range(dev, 0, "contrast", 0, 100);
1568 if (!dev->mode_config.tv_contrast_property)
1569 goto nomem;
1570
1571 dev->mode_config.tv_flicker_reduction_property =
1572 drm_property_create_range(dev, 0, "flicker reduction", 0, 100);
1573 if (!dev->mode_config.tv_flicker_reduction_property)
1574 goto nomem;
1575
1576 dev->mode_config.tv_overscan_property =
1577 drm_property_create_range(dev, 0, "overscan", 0, 100);
1578 if (!dev->mode_config.tv_overscan_property)
1579 goto nomem;
1580
1581 dev->mode_config.tv_saturation_property =
1582 drm_property_create_range(dev, 0, "saturation", 0, 100);
1583 if (!dev->mode_config.tv_saturation_property)
1584 goto nomem;
1585
1586 dev->mode_config.tv_hue_property =
1587 drm_property_create_range(dev, 0, "hue", 0, 100);
1588 if (!dev->mode_config.tv_hue_property)
1589 goto nomem;
1590
1591 return 0;
1592nomem:
1593 return -ENOMEM;
1594}
1595EXPORT_SYMBOL(drm_mode_create_tv_properties);
1596
1597/**
1598 * drm_mode_create_scaling_mode_property - create scaling mode property
1599 * @dev: DRM device
1600 *
1601 * Called by a driver the first time it's needed, must be attached to desired
1602 * connectors.
1603 *
1604 * Atomic drivers should use drm_connector_attach_scaling_mode_property()
1605 * instead to correctly assign &drm_connector_state.picture_aspect_ratio
1606 * in the atomic state.
1607 */
1608int drm_mode_create_scaling_mode_property(struct drm_device *dev)
1609{
1610 struct drm_property *scaling_mode;
1611
1612 if (dev->mode_config.scaling_mode_property)
1613 return 0;
1614
1615 scaling_mode =
1616 drm_property_create_enum(dev, 0, "scaling mode",
1617 drm_scaling_mode_enum_list,
1618 ARRAY_SIZE(drm_scaling_mode_enum_list));
1619
1620 dev->mode_config.scaling_mode_property = scaling_mode;
1621
1622 return 0;
1623}
1624EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);
1625
1626/**
1627 * DOC: Variable refresh properties
1628 *
1629 * Variable refresh rate capable displays can dynamically adjust their
1630 * refresh rate by extending the duration of their vertical front porch
1631 * until page flip or timeout occurs. This can reduce or remove stuttering
1632 * and latency in scenarios where the page flip does not align with the
1633 * vblank interval.
1634 *
1635 * An example scenario would be an application flipping at a constant rate
1636 * of 48Hz on a 60Hz display. The page flip will frequently miss the vblank
1637 * interval and the same contents will be displayed twice. This can be
1638 * observed as stuttering for content with motion.
1639 *
1640 * If variable refresh rate was active on a display that supported a
1641 * variable refresh range from 35Hz to 60Hz no stuttering would be observable
1642 * for the example scenario. The minimum supported variable refresh rate of
1643 * 35Hz is below the page flip frequency and the vertical front porch can
1644 * be extended until the page flip occurs. The vblank interval will be
1645 * directly aligned to the page flip rate.
1646 *
1647 * Not all userspace content is suitable for use with variable refresh rate.
1648 * Large and frequent changes in vertical front porch duration may worsen
1649 * perceived stuttering for input sensitive applications.
1650 *
1651 * Panel brightness will also vary with vertical front porch duration. Some
1652 * panels may have noticeable differences in brightness between the minimum
1653 * vertical front porch duration and the maximum vertical front porch duration.
1654 * Large and frequent changes in vertical front porch duration may produce
1655 * observable flickering for such panels.
1656 *
1657 * Userspace control for variable refresh rate is supported via properties
1658 * on the &drm_connector and &drm_crtc objects.
1659 *
1660 * "vrr_capable":
1661 * Optional &drm_connector boolean property that drivers should attach
1662 * with drm_connector_attach_vrr_capable_property() on connectors that
1663 * could support variable refresh rates. Drivers should update the
1664 * property value by calling drm_connector_set_vrr_capable_property().
1665 *
1666 * Absence of the property should indicate absence of support.
1667 *
1668 * "VRR_ENABLED":
1669 * Default &drm_crtc boolean property that notifies the driver that the
1670 * content on the CRTC is suitable for variable refresh rate presentation.
1671 * The driver will take this property as a hint to enable variable
1672 * refresh rate support if the receiver supports it, ie. if the
1673 * "vrr_capable" property is true on the &drm_connector object. The
1674 * vertical front porch duration will be extended until page-flip or
1675 * timeout when enabled.
1676 *
1677 * The minimum vertical front porch duration is defined as the vertical
1678 * front porch duration for the current mode.
1679 *
1680 * The maximum vertical front porch duration is greater than or equal to
1681 * the minimum vertical front porch duration. The duration is derived
1682 * from the minimum supported variable refresh rate for the connector.
1683 *
1684 * The driver may place further restrictions within these minimum
1685 * and maximum bounds.
1686 */
1687
1688/**
1689 * drm_connector_attach_vrr_capable_property - creates the
1690 * vrr_capable property
1691 * @connector: connector to create the vrr_capable property on.
1692 *
1693 * This is used by atomic drivers to add support for querying
1694 * variable refresh rate capability for a connector.
1695 *
1696 * Returns:
1697 * Zero on success, negative errno on failure.
1698 */
1699int drm_connector_attach_vrr_capable_property(
1700 struct drm_connector *connector)
1701{
1702 struct drm_device *dev = connector->dev;
1703 struct drm_property *prop;
1704
1705 if (!connector->vrr_capable_property) {
1706 prop = drm_property_create_bool(dev, DRM_MODE_PROP_IMMUTABLE,
1707 "vrr_capable");
1708 if (!prop)
1709 return -ENOMEM;
1710
1711 connector->vrr_capable_property = prop;
1712 drm_object_attach_property(&connector->base, prop, 0);
1713 }
1714
1715 return 0;
1716}
1717EXPORT_SYMBOL(drm_connector_attach_vrr_capable_property);
1718
1719/**
1720 * drm_connector_attach_scaling_mode_property - attach atomic scaling mode property
1721 * @connector: connector to attach scaling mode property on.
1722 * @scaling_mode_mask: or'ed mask of BIT(%DRM_MODE_SCALE_\*).
1723 *
1724 * This is used to add support for scaling mode to atomic drivers.
1725 * The scaling mode will be set to &drm_connector_state.picture_aspect_ratio
1726 * and can be used from &drm_connector_helper_funcs->atomic_check for validation.
1727 *
1728 * This is the atomic version of drm_mode_create_scaling_mode_property().
1729 *
1730 * Returns:
1731 * Zero on success, negative errno on failure.
1732 */
1733int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1734 u32 scaling_mode_mask)
1735{
1736 struct drm_device *dev = connector->dev;
1737 struct drm_property *scaling_mode_property;
1738 int i;
1739 const unsigned valid_scaling_mode_mask =
1740 (1U << ARRAY_SIZE(drm_scaling_mode_enum_list)) - 1;
1741
1742 if (WARN_ON(hweight32(scaling_mode_mask) < 2 ||
1743 scaling_mode_mask & ~valid_scaling_mode_mask))
1744 return -EINVAL;
1745
1746 scaling_mode_property =
1747 drm_property_create(dev, DRM_MODE_PROP_ENUM, "scaling mode",
1748 hweight32(scaling_mode_mask));
1749
1750 if (!scaling_mode_property)
1751 return -ENOMEM;
1752
1753 for (i = 0; i < ARRAY_SIZE(drm_scaling_mode_enum_list); i++) {
1754 int ret;
1755
1756 if (!(BIT(i) & scaling_mode_mask))
1757 continue;
1758
1759 ret = drm_property_add_enum(scaling_mode_property,
1760 drm_scaling_mode_enum_list[i].type,
1761 drm_scaling_mode_enum_list[i].name);
1762
1763 if (ret) {
1764 drm_property_destroy(dev, scaling_mode_property);
1765
1766 return ret;
1767 }
1768 }
1769
1770 drm_object_attach_property(&connector->base,
1771 scaling_mode_property, 0);
1772
1773 connector->scaling_mode_property = scaling_mode_property;
1774
1775 return 0;
1776}
1777EXPORT_SYMBOL(drm_connector_attach_scaling_mode_property);
1778
1779/**
1780 * drm_mode_create_aspect_ratio_property - create aspect ratio property
1781 * @dev: DRM device
1782 *
1783 * Called by a driver the first time it's needed, must be attached to desired
1784 * connectors.
1785 *
1786 * Returns:
1787 * Zero on success, negative errno on failure.
1788 */
1789int drm_mode_create_aspect_ratio_property(struct drm_device *dev)
1790{
1791 if (dev->mode_config.aspect_ratio_property)
1792 return 0;
1793
1794 dev->mode_config.aspect_ratio_property =
1795 drm_property_create_enum(dev, 0, "aspect ratio",
1796 drm_aspect_ratio_enum_list,
1797 ARRAY_SIZE(drm_aspect_ratio_enum_list));
1798
1799 if (dev->mode_config.aspect_ratio_property == NULL)
1800 return -ENOMEM;
1801
1802 return 0;
1803}
1804EXPORT_SYMBOL(drm_mode_create_aspect_ratio_property);
1805
1806/**
1807 * DOC: standard connector properties
1808 *
1809 * Colorspace:
1810 * This property helps select a suitable colorspace based on the sink
1811 * capability. Modern sink devices support wider gamut like BT2020.
1812 * This helps switch to BT2020 mode if the BT2020 encoded video stream
1813 * is being played by the user, same for any other colorspace. Thereby
1814 * giving a good visual experience to users.
1815 *
1816 * The expectation from userspace is that it should parse the EDID
1817 * and get supported colorspaces. Use this property and switch to the
1818 * one supported. Sink supported colorspaces should be retrieved by
1819 * userspace from EDID and driver will not explicitly expose them.
1820 *
1821 * Basically the expectation from userspace is:
1822 * - Set up CRTC DEGAMMA/CTM/GAMMA to convert to some sink
1823 * colorspace
1824 * - Set this new property to let the sink know what it
1825 * converted the CRTC output to.
1826 * - This property is just to inform sink what colorspace
1827 * source is trying to drive.
1828 *
1829 * Because between HDMI and DP have different colorspaces,
1830 * drm_mode_create_hdmi_colorspace_property() is used for HDMI connector and
1831 * drm_mode_create_dp_colorspace_property() is used for DP connector.
1832 */
1833
1834/**
1835 * drm_mode_create_hdmi_colorspace_property - create hdmi colorspace property
1836 * @connector: connector to create the Colorspace property on.
1837 *
1838 * Called by a driver the first time it's needed, must be attached to desired
1839 * HDMI connectors.
1840 *
1841 * Returns:
1842 * Zero on success, negative errno on failure.
1843 */
1844int drm_mode_create_hdmi_colorspace_property(struct drm_connector *connector)
1845{
1846 struct drm_device *dev = connector->dev;
1847
1848 if (connector->colorspace_property)
1849 return 0;
1850
1851 connector->colorspace_property =
1852 drm_property_create_enum(dev, DRM_MODE_PROP_ENUM, "Colorspace",
1853 hdmi_colorspaces,
1854 ARRAY_SIZE(hdmi_colorspaces));
1855
1856 if (!connector->colorspace_property)
1857 return -ENOMEM;
1858
1859 return 0;
1860}
1861EXPORT_SYMBOL(drm_mode_create_hdmi_colorspace_property);
1862
1863/**
1864 * drm_mode_create_dp_colorspace_property - create dp colorspace property
1865 * @connector: connector to create the Colorspace property on.
1866 *
1867 * Called by a driver the first time it's needed, must be attached to desired
1868 * DP connectors.
1869 *
1870 * Returns:
1871 * Zero on success, negative errno on failure.
1872 */
1873int drm_mode_create_dp_colorspace_property(struct drm_connector *connector)
1874{
1875 struct drm_device *dev = connector->dev;
1876
1877 if (connector->colorspace_property)
1878 return 0;
1879
1880 connector->colorspace_property =
1881 drm_property_create_enum(dev, DRM_MODE_PROP_ENUM, "Colorspace",
1882 dp_colorspaces,
1883 ARRAY_SIZE(dp_colorspaces));
1884
1885 if (!connector->colorspace_property)
1886 return -ENOMEM;
1887
1888 return 0;
1889}
1890EXPORT_SYMBOL(drm_mode_create_dp_colorspace_property);
1891
1892/**
1893 * drm_mode_create_content_type_property - create content type property
1894 * @dev: DRM device
1895 *
1896 * Called by a driver the first time it's needed, must be attached to desired
1897 * connectors.
1898 *
1899 * Returns:
1900 * Zero on success, negative errno on failure.
1901 */
1902int drm_mode_create_content_type_property(struct drm_device *dev)
1903{
1904 if (dev->mode_config.content_type_property)
1905 return 0;
1906
1907 dev->mode_config.content_type_property =
1908 drm_property_create_enum(dev, 0, "content type",
1909 drm_content_type_enum_list,
1910 ARRAY_SIZE(drm_content_type_enum_list));
1911
1912 if (dev->mode_config.content_type_property == NULL)
1913 return -ENOMEM;
1914
1915 return 0;
1916}
1917EXPORT_SYMBOL(drm_mode_create_content_type_property);
1918
1919/**
1920 * drm_mode_create_suggested_offset_properties - create suggests offset properties
1921 * @dev: DRM device
1922 *
1923 * Create the suggested x/y offset property for connectors.
1924 */
1925int drm_mode_create_suggested_offset_properties(struct drm_device *dev)
1926{
1927 if (dev->mode_config.suggested_x_property && dev->mode_config.suggested_y_property)
1928 return 0;
1929
1930 dev->mode_config.suggested_x_property =
1931 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested X", 0, 0xffffffff);
1932
1933 dev->mode_config.suggested_y_property =
1934 drm_property_create_range(dev, DRM_MODE_PROP_IMMUTABLE, "suggested Y", 0, 0xffffffff);
1935
1936 if (dev->mode_config.suggested_x_property == NULL ||
1937 dev->mode_config.suggested_y_property == NULL)
1938 return -ENOMEM;
1939 return 0;
1940}
1941EXPORT_SYMBOL(drm_mode_create_suggested_offset_properties);
1942
1943/**
1944 * drm_connector_set_path_property - set tile property on connector
1945 * @connector: connector to set property on.
1946 * @path: path to use for property; must not be NULL.
1947 *
1948 * This creates a property to expose to userspace to specify a
1949 * connector path. This is mainly used for DisplayPort MST where
1950 * connectors have a topology and we want to allow userspace to give
1951 * them more meaningful names.
1952 *
1953 * Returns:
1954 * Zero on success, negative errno on failure.
1955 */
1956int drm_connector_set_path_property(struct drm_connector *connector,
1957 const char *path)
1958{
1959 struct drm_device *dev = connector->dev;
1960 int ret;
1961
1962 ret = drm_property_replace_global_blob(dev,
1963 &connector->path_blob_ptr,
1964 strlen(path) + 1,
1965 path,
1966 &connector->base,
1967 dev->mode_config.path_property);
1968 return ret;
1969}
1970EXPORT_SYMBOL(drm_connector_set_path_property);
1971
1972/**
1973 * drm_connector_set_tile_property - set tile property on connector
1974 * @connector: connector to set property on.
1975 *
1976 * This looks up the tile information for a connector, and creates a
1977 * property for userspace to parse if it exists. The property is of
1978 * the form of 8 integers using ':' as a separator.
1979 * This is used for dual port tiled displays with DisplayPort SST
1980 * or DisplayPort MST connectors.
1981 *
1982 * Returns:
1983 * Zero on success, errno on failure.
1984 */
1985int drm_connector_set_tile_property(struct drm_connector *connector)
1986{
1987 struct drm_device *dev = connector->dev;
1988 char tile[256];
1989 int ret;
1990
1991 if (!connector->has_tile) {
1992 ret = drm_property_replace_global_blob(dev,
1993 &connector->tile_blob_ptr,
1994 0,
1995 NULL,
1996 &connector->base,
1997 dev->mode_config.tile_property);
1998 return ret;
1999 }
2000
2001 snprintf(tile, 256, "%d:%d:%d:%d:%d:%d:%d:%d",
2002 connector->tile_group->id, connector->tile_is_single_monitor,
2003 connector->num_h_tile, connector->num_v_tile,
2004 connector->tile_h_loc, connector->tile_v_loc,
2005 connector->tile_h_size, connector->tile_v_size);
2006
2007 ret = drm_property_replace_global_blob(dev,
2008 &connector->tile_blob_ptr,
2009 strlen(tile) + 1,
2010 tile,
2011 &connector->base,
2012 dev->mode_config.tile_property);
2013 return ret;
2014}
2015EXPORT_SYMBOL(drm_connector_set_tile_property);
2016
2017/**
2018 * drm_connector_update_edid_property - update the edid property of a connector
2019 * @connector: drm connector
2020 * @edid: new value of the edid property
2021 *
2022 * This function creates a new blob modeset object and assigns its id to the
2023 * connector's edid property.
2024 * Since we also parse tile information from EDID's displayID block, we also
2025 * set the connector's tile property here. See drm_connector_set_tile_property()
2026 * for more details.
2027 *
2028 * Returns:
2029 * Zero on success, negative errno on failure.
2030 */
2031int drm_connector_update_edid_property(struct drm_connector *connector,
2032 const struct edid *edid)
2033{
2034 struct drm_device *dev = connector->dev;
2035 size_t size = 0;
2036 int ret;
2037 const struct edid *old_edid;
2038
2039 /* ignore requests to set edid when overridden */
2040 if (connector->override_edid)
2041 return 0;
2042
2043 if (edid)
2044 size = EDID_LENGTH * (1 + edid->extensions);
2045
2046 /* Set the display info, using edid if available, otherwise
2047 * resetting the values to defaults. This duplicates the work
2048 * done in drm_add_edid_modes, but that function is not
2049 * consistently called before this one in all drivers and the
2050 * computation is cheap enough that it seems better to
2051 * duplicate it rather than attempt to ensure some arbitrary
2052 * ordering of calls.
2053 */
2054 if (edid)
2055 drm_add_display_info(connector, edid);
2056 else
2057 drm_reset_display_info(connector);
2058
2059 drm_update_tile_info(connector, edid);
2060
2061 if (connector->edid_blob_ptr) {
2062 old_edid = (const struct edid *)connector->edid_blob_ptr->data;
2063 if (old_edid) {
2064 if (!drm_edid_are_equal(edid, old_edid)) {
2065 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] Edid was changed.\n",
2066 connector->base.id, connector->name);
2067
2068 connector->epoch_counter += 1;
2069 DRM_DEBUG_KMS("Updating change counter to %llu\n",
2070 connector->epoch_counter);
2071 }
2072 }
2073 }
2074
2075 drm_object_property_set_value(&connector->base,
2076 dev->mode_config.non_desktop_property,
2077 connector->display_info.non_desktop);
2078
2079 ret = drm_property_replace_global_blob(dev,
2080 &connector->edid_blob_ptr,
2081 size,
2082 edid,
2083 &connector->base,
2084 dev->mode_config.edid_property);
2085 if (ret)
2086 return ret;
2087 return drm_connector_set_tile_property(connector);
2088}
2089EXPORT_SYMBOL(drm_connector_update_edid_property);
2090
2091/**
2092 * drm_connector_set_link_status_property - Set link status property of a connector
2093 * @connector: drm connector
2094 * @link_status: new value of link status property (0: Good, 1: Bad)
2095 *
2096 * In usual working scenario, this link status property will always be set to
2097 * "GOOD". If something fails during or after a mode set, the kernel driver
2098 * may set this link status property to "BAD". The caller then needs to send a
2099 * hotplug uevent for userspace to re-check the valid modes through
2100 * GET_CONNECTOR_IOCTL and retry modeset.
2101 *
2102 * Note: Drivers cannot rely on userspace to support this property and
2103 * issue a modeset. As such, they may choose to handle issues (like
2104 * re-training a link) without userspace's intervention.
2105 *
2106 * The reason for adding this property is to handle link training failures, but
2107 * it is not limited to DP or link training. For example, if we implement
2108 * asynchronous setcrtc, this property can be used to report any failures in that.
2109 */
2110void drm_connector_set_link_status_property(struct drm_connector *connector,
2111 uint64_t link_status)
2112{
2113 struct drm_device *dev = connector->dev;
2114
2115 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2116 connector->state->link_status = link_status;
2117 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2118}
2119EXPORT_SYMBOL(drm_connector_set_link_status_property);
2120
2121/**
2122 * drm_connector_attach_max_bpc_property - attach "max bpc" property
2123 * @connector: connector to attach max bpc property on.
2124 * @min: The minimum bit depth supported by the connector.
2125 * @max: The maximum bit depth supported by the connector.
2126 *
2127 * This is used to add support for limiting the bit depth on a connector.
2128 *
2129 * Returns:
2130 * Zero on success, negative errno on failure.
2131 */
2132int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
2133 int min, int max)
2134{
2135 struct drm_device *dev = connector->dev;
2136 struct drm_property *prop;
2137
2138 prop = connector->max_bpc_property;
2139 if (!prop) {
2140 prop = drm_property_create_range(dev, 0, "max bpc", min, max);
2141 if (!prop)
2142 return -ENOMEM;
2143
2144 connector->max_bpc_property = prop;
2145 }
2146
2147 drm_object_attach_property(&connector->base, prop, max);
2148 connector->state->max_requested_bpc = max;
2149 connector->state->max_bpc = max;
2150
2151 return 0;
2152}
2153EXPORT_SYMBOL(drm_connector_attach_max_bpc_property);
2154
2155/**
2156 * drm_connector_attach_hdr_output_metadata_property - attach "HDR_OUTPUT_METADA" property
2157 * @connector: connector to attach the property on.
2158 *
2159 * This is used to allow the userspace to send HDR Metadata to the
2160 * driver.
2161 *
2162 * Returns:
2163 * Zero on success, negative errno on failure.
2164 */
2165int drm_connector_attach_hdr_output_metadata_property(struct drm_connector *connector)
2166{
2167 struct drm_device *dev = connector->dev;
2168 struct drm_property *prop = dev->mode_config.hdr_output_metadata_property;
2169
2170 drm_object_attach_property(&connector->base, prop, 0);
2171
2172 return 0;
2173}
2174EXPORT_SYMBOL(drm_connector_attach_hdr_output_metadata_property);
2175
2176/**
2177 * drm_connector_attach_colorspace_property - attach "Colorspace" property
2178 * @connector: connector to attach the property on.
2179 *
2180 * This is used to allow the userspace to signal the output colorspace
2181 * to the driver.
2182 *
2183 * Returns:
2184 * Zero on success, negative errno on failure.
2185 */
2186int drm_connector_attach_colorspace_property(struct drm_connector *connector)
2187{
2188 struct drm_property *prop = connector->colorspace_property;
2189
2190 drm_object_attach_property(&connector->base, prop, DRM_MODE_COLORIMETRY_DEFAULT);
2191
2192 return 0;
2193}
2194EXPORT_SYMBOL(drm_connector_attach_colorspace_property);
2195
2196/**
2197 * drm_connector_atomic_hdr_metadata_equal - checks if the hdr metadata changed
2198 * @old_state: old connector state to compare
2199 * @new_state: new connector state to compare
2200 *
2201 * This is used by HDR-enabled drivers to test whether the HDR metadata
2202 * have changed between two different connector state (and thus probably
2203 * requires a full blown mode change).
2204 *
2205 * Returns:
2206 * True if the metadata are equal, False otherwise
2207 */
2208bool drm_connector_atomic_hdr_metadata_equal(struct drm_connector_state *old_state,
2209 struct drm_connector_state *new_state)
2210{
2211 struct drm_property_blob *old_blob = old_state->hdr_output_metadata;
2212 struct drm_property_blob *new_blob = new_state->hdr_output_metadata;
2213
2214 if (!old_blob || !new_blob)
2215 return old_blob == new_blob;
2216
2217 if (old_blob->length != new_blob->length)
2218 return false;
2219
2220 return !memcmp(old_blob->data, new_blob->data, old_blob->length);
2221}
2222EXPORT_SYMBOL(drm_connector_atomic_hdr_metadata_equal);
2223
2224/**
2225 * drm_connector_set_vrr_capable_property - sets the variable refresh rate
2226 * capable property for a connector
2227 * @connector: drm connector
2228 * @capable: True if the connector is variable refresh rate capable
2229 *
2230 * Should be used by atomic drivers to update the indicated support for
2231 * variable refresh rate over a connector.
2232 */
2233void drm_connector_set_vrr_capable_property(
2234 struct drm_connector *connector, bool capable)
2235{
2236 drm_object_property_set_value(&connector->base,
2237 connector->vrr_capable_property,
2238 capable);
2239}
2240EXPORT_SYMBOL(drm_connector_set_vrr_capable_property);
2241
2242/**
2243 * drm_connector_set_panel_orientation - sets the connector's panel_orientation
2244 * @connector: connector for which to set the panel-orientation property.
2245 * @panel_orientation: drm_panel_orientation value to set
2246 *
2247 * This function sets the connector's panel_orientation and attaches
2248 * a "panel orientation" property to the connector.
2249 *
2250 * Calling this function on a connector where the panel_orientation has
2251 * already been set is a no-op (e.g. the orientation has been overridden with
2252 * a kernel commandline option).
2253 *
2254 * It is allowed to call this function with a panel_orientation of
2255 * DRM_MODE_PANEL_ORIENTATION_UNKNOWN, in which case it is a no-op.
2256 *
2257 * Returns:
2258 * Zero on success, negative errno on failure.
2259 */
2260int drm_connector_set_panel_orientation(
2261 struct drm_connector *connector,
2262 enum drm_panel_orientation panel_orientation)
2263{
2264 struct drm_device *dev = connector->dev;
2265 struct drm_display_info *info = &connector->display_info;
2266 struct drm_property *prop;
2267
2268 /* Already set? */
2269 if (info->panel_orientation != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2270 return 0;
2271
2272 /* Don't attach the property if the orientation is unknown */
2273 if (panel_orientation == DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2274 return 0;
2275
2276 info->panel_orientation = panel_orientation;
2277
2278 prop = dev->mode_config.panel_orientation_property;
2279 if (!prop) {
2280 prop = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
2281 "panel orientation",
2282 drm_panel_orientation_enum_list,
2283 ARRAY_SIZE(drm_panel_orientation_enum_list));
2284 if (!prop)
2285 return -ENOMEM;
2286
2287 dev->mode_config.panel_orientation_property = prop;
2288 }
2289
2290 drm_object_attach_property(&connector->base, prop,
2291 info->panel_orientation);
2292 return 0;
2293}
2294EXPORT_SYMBOL(drm_connector_set_panel_orientation);
2295
2296/**
2297 * drm_connector_set_panel_orientation_with_quirk -
2298 * set the connector's panel_orientation after checking for quirks
2299 * @connector: connector for which to init the panel-orientation property.
2300 * @panel_orientation: drm_panel_orientation value to set
2301 * @width: width in pixels of the panel, used for panel quirk detection
2302 * @height: height in pixels of the panel, used for panel quirk detection
2303 *
2304 * Like drm_connector_set_panel_orientation(), but with a check for platform
2305 * specific (e.g. DMI based) quirks overriding the passed in panel_orientation.
2306 *
2307 * Returns:
2308 * Zero on success, negative errno on failure.
2309 */
2310int drm_connector_set_panel_orientation_with_quirk(
2311 struct drm_connector *connector,
2312 enum drm_panel_orientation panel_orientation,
2313 int width, int height)
2314{
2315 int orientation_quirk;
2316
2317 orientation_quirk = drm_get_panel_orientation_quirk(width, height);
2318 if (orientation_quirk != DRM_MODE_PANEL_ORIENTATION_UNKNOWN)
2319 panel_orientation = orientation_quirk;
2320
2321 return drm_connector_set_panel_orientation(connector,
2322 panel_orientation);
2323}
2324EXPORT_SYMBOL(drm_connector_set_panel_orientation_with_quirk);
2325
2326int drm_connector_set_obj_prop(struct drm_mode_object *obj,
2327 struct drm_property *property,
2328 uint64_t value)
2329{
2330 int ret = -EINVAL;
2331 struct drm_connector *connector = obj_to_connector(obj);
2332
2333 /* Do DPMS ourselves */
2334 if (property == connector->dev->mode_config.dpms_property) {
2335 ret = (*connector->funcs->dpms)(connector, (int)value);
2336 } else if (connector->funcs->set_property)
2337 ret = connector->funcs->set_property(connector, property, value);
2338
2339 if (!ret)
2340 drm_object_property_set_value(&connector->base, property, value);
2341 return ret;
2342}
2343
2344int drm_connector_property_set_ioctl(struct drm_device *dev,
2345 void *data, struct drm_file *file_priv)
2346{
2347 struct drm_mode_connector_set_property *conn_set_prop = data;
2348 struct drm_mode_obj_set_property obj_set_prop = {
2349 .value = conn_set_prop->value,
2350 .prop_id = conn_set_prop->prop_id,
2351 .obj_id = conn_set_prop->connector_id,
2352 .obj_type = DRM_MODE_OBJECT_CONNECTOR
2353 };
2354
2355 /* It does all the locking and checking we need */
2356 return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
2357}
2358
2359static struct drm_encoder *drm_connector_get_encoder(struct drm_connector *connector)
2360{
2361 /* For atomic drivers only state objects are synchronously updated and
2362 * protected by modeset locks, so check those first.
2363 */
2364 if (connector->state)
2365 return connector->state->best_encoder;
2366 return connector->encoder;
2367}
2368
2369static bool
2370drm_mode_expose_to_userspace(const struct drm_display_mode *mode,
2371 const struct list_head *modes,
2372 const struct drm_file *file_priv)
2373{
2374 /*
2375 * If user-space hasn't configured the driver to expose the stereo 3D
2376 * modes, don't expose them.
2377 */
2378 if (!file_priv->stereo_allowed && drm_mode_is_stereo(mode))
2379 return false;
2380 /*
2381 * If user-space hasn't configured the driver to expose the modes
2382 * with aspect-ratio, don't expose them. However if such a mode
2383 * is unique, let it be exposed, but reset the aspect-ratio flags
2384 * while preparing the list of user-modes.
2385 */
2386 if (!file_priv->aspect_ratio_allowed) {
2387 const struct drm_display_mode *mode_itr;
2388
2389 list_for_each_entry(mode_itr, modes, head) {
2390 if (mode_itr->expose_to_userspace &&
2391 drm_mode_match(mode_itr, mode,
2392 DRM_MODE_MATCH_TIMINGS |
2393 DRM_MODE_MATCH_CLOCK |
2394 DRM_MODE_MATCH_FLAGS |
2395 DRM_MODE_MATCH_3D_FLAGS))
2396 return false;
2397 }
2398 }
2399
2400 return true;
2401}
2402
2403int drm_mode_getconnector(struct drm_device *dev, void *data,
2404 struct drm_file *file_priv)
2405{
2406 struct drm_mode_get_connector *out_resp = data;
2407 struct drm_connector *connector;
2408 struct drm_encoder *encoder;
2409 struct drm_display_mode *mode;
2410 int mode_count = 0;
2411 int encoders_count = 0;
2412 int ret = 0;
2413 int copied = 0;
2414 struct drm_mode_modeinfo u_mode;
2415 struct drm_mode_modeinfo __user *mode_ptr;
2416 uint32_t __user *encoder_ptr;
2417
2418 if (!drm_core_check_feature(dev, DRIVER_MODESET))
2419 return -EOPNOTSUPP;
2420
2421 memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));
2422
2423 connector = drm_connector_lookup(dev, file_priv, out_resp->connector_id);
2424 if (!connector)
2425 return -ENOENT;
2426
2427 encoders_count = hweight32(connector->possible_encoders);
2428
2429 if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
2430 copied = 0;
2431 encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
2432
2433 drm_connector_for_each_possible_encoder(connector, encoder) {
2434 if (put_user(encoder->base.id, encoder_ptr + copied)) {
2435 ret = -EFAULT;
2436 goto out;
2437 }
2438 copied++;
2439 }
2440 }
2441 out_resp->count_encoders = encoders_count;
2442
2443 out_resp->connector_id = connector->base.id;
2444 out_resp->connector_type = connector->connector_type;
2445 out_resp->connector_type_id = connector->connector_type_id;
2446
2447 mutex_lock(&dev->mode_config.mutex);
2448 if (out_resp->count_modes == 0) {
2449 if (drm_is_current_master(file_priv))
2450 connector->funcs->fill_modes(connector,
2451 dev->mode_config.max_width,
2452 dev->mode_config.max_height);
2453 else
2454 drm_dbg_kms(dev, "User-space requested a forced probe on [CONNECTOR:%d:%s] but is not the DRM master, demoting to read-only probe",
2455 connector->base.id, connector->name);
2456 }
2457
2458 out_resp->mm_width = connector->display_info.width_mm;
2459 out_resp->mm_height = connector->display_info.height_mm;
2460 out_resp->subpixel = connector->display_info.subpixel_order;
2461 out_resp->connection = connector->status;
2462
2463 /* delayed so we get modes regardless of pre-fill_modes state */
2464 list_for_each_entry(mode, &connector->modes, head) {
2465 WARN_ON(mode->expose_to_userspace);
2466
2467 if (drm_mode_expose_to_userspace(mode, &connector->modes,
2468 file_priv)) {
2469 mode->expose_to_userspace = true;
2470 mode_count++;
2471 }
2472 }
2473
2474 /*
2475 * This ioctl is called twice, once to determine how much space is
2476 * needed, and the 2nd time to fill it.
2477 */
2478 if ((out_resp->count_modes >= mode_count) && mode_count) {
2479 copied = 0;
2480 mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
2481 list_for_each_entry(mode, &connector->modes, head) {
2482 if (!mode->expose_to_userspace)
2483 continue;
2484
2485 /* Clear the tag for the next time around */
2486 mode->expose_to_userspace = false;
2487
2488 drm_mode_convert_to_umode(&u_mode, mode);
2489 /*
2490 * Reset aspect ratio flags of user-mode, if modes with
2491 * aspect-ratio are not supported.
2492 */
2493 if (!file_priv->aspect_ratio_allowed)
2494 u_mode.flags &= ~DRM_MODE_FLAG_PIC_AR_MASK;
2495 if (copy_to_user(mode_ptr + copied,
2496 &u_mode, sizeof(u_mode))) {
2497 ret = -EFAULT;
2498
2499 /*
2500 * Clear the tag for the rest of
2501 * the modes for the next time around.
2502 */
2503 list_for_each_entry_continue(mode, &connector->modes, head)
2504 mode->expose_to_userspace = false;
2505
2506 mutex_unlock(&dev->mode_config.mutex);
2507
2508 goto out;
2509 }
2510 copied++;
2511 }
2512 } else {
2513 /* Clear the tag for the next time around */
2514 list_for_each_entry(mode, &connector->modes, head)
2515 mode->expose_to_userspace = false;
2516 }
2517
2518 out_resp->count_modes = mode_count;
2519 mutex_unlock(&dev->mode_config.mutex);
2520
2521 drm_modeset_lock(&dev->mode_config.connection_mutex, NULL);
2522 encoder = drm_connector_get_encoder(connector);
2523 if (encoder)
2524 out_resp->encoder_id = encoder->base.id;
2525 else
2526 out_resp->encoder_id = 0;
2527
2528 /* Only grab properties after probing, to make sure EDID and other
2529 * properties reflect the latest status.
2530 */
2531 ret = drm_mode_object_get_properties(&connector->base, file_priv->atomic,
2532 (uint32_t __user *)(unsigned long)(out_resp->props_ptr),
2533 (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr),
2534 &out_resp->count_props);
2535 drm_modeset_unlock(&dev->mode_config.connection_mutex);
2536
2537out:
2538 drm_connector_put(connector);
2539
2540 return ret;
2541}
2542
2543
2544/**
2545 * DOC: Tile group
2546 *
2547 * Tile groups are used to represent tiled monitors with a unique integer
2548 * identifier. Tiled monitors using DisplayID v1.3 have a unique 8-byte handle,
2549 * we store this in a tile group, so we have a common identifier for all tiles
2550 * in a monitor group. The property is called "TILE". Drivers can manage tile
2551 * groups using drm_mode_create_tile_group(), drm_mode_put_tile_group() and
2552 * drm_mode_get_tile_group(). But this is only needed for internal panels where
2553 * the tile group information is exposed through a non-standard way.
2554 */
2555
2556static void drm_tile_group_free(struct kref *kref)
2557{
2558 struct drm_tile_group *tg = container_of(kref, struct drm_tile_group, refcount);
2559 struct drm_device *dev = tg->dev;
2560
2561 mutex_lock(&dev->mode_config.idr_mutex);
2562 idr_remove(&dev->mode_config.tile_idr, tg->id);
2563 mutex_unlock(&dev->mode_config.idr_mutex);
2564 kfree(tg);
2565}
2566
2567/**
2568 * drm_mode_put_tile_group - drop a reference to a tile group.
2569 * @dev: DRM device
2570 * @tg: tile group to drop reference to.
2571 *
2572 * drop reference to tile group and free if 0.
2573 */
2574void drm_mode_put_tile_group(struct drm_device *dev,
2575 struct drm_tile_group *tg)
2576{
2577 kref_put(&tg->refcount, drm_tile_group_free);
2578}
2579EXPORT_SYMBOL(drm_mode_put_tile_group);
2580
2581/**
2582 * drm_mode_get_tile_group - get a reference to an existing tile group
2583 * @dev: DRM device
2584 * @topology: 8-bytes unique per monitor.
2585 *
2586 * Use the unique bytes to get a reference to an existing tile group.
2587 *
2588 * RETURNS:
2589 * tile group or NULL if not found.
2590 */
2591struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
2592 const char topology[8])
2593{
2594 struct drm_tile_group *tg;
2595 int id;
2596
2597 mutex_lock(&dev->mode_config.idr_mutex);
2598 idr_for_each_entry(&dev->mode_config.tile_idr, tg, id) {
2599 if (!memcmp(tg->group_data, topology, 8)) {
2600 if (!kref_get_unless_zero(&tg->refcount))
2601 tg = NULL;
2602 mutex_unlock(&dev->mode_config.idr_mutex);
2603 return tg;
2604 }
2605 }
2606 mutex_unlock(&dev->mode_config.idr_mutex);
2607 return NULL;
2608}
2609EXPORT_SYMBOL(drm_mode_get_tile_group);
2610
2611/**
2612 * drm_mode_create_tile_group - create a tile group from a displayid description
2613 * @dev: DRM device
2614 * @topology: 8-bytes unique per monitor.
2615 *
2616 * Create a tile group for the unique monitor, and get a unique
2617 * identifier for the tile group.
2618 *
2619 * RETURNS:
2620 * new tile group or NULL.
2621 */
2622struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
2623 const char topology[8])
2624{
2625 struct drm_tile_group *tg;
2626 int ret;
2627
2628 tg = kzalloc(sizeof(*tg), GFP_KERNEL);
2629 if (!tg)
2630 return NULL;
2631
2632 kref_init(&tg->refcount);
2633 memcpy(tg->group_data, topology, 8);
2634 tg->dev = dev;
2635
2636 mutex_lock(&dev->mode_config.idr_mutex);
2637 ret = idr_alloc(&dev->mode_config.tile_idr, tg, 1, 0, GFP_KERNEL);
2638 if (ret >= 0) {
2639 tg->id = ret;
2640 } else {
2641 kfree(tg);
2642 tg = NULL;
2643 }
2644
2645 mutex_unlock(&dev->mode_config.idr_mutex);
2646 return tg;
2647}
2648EXPORT_SYMBOL(drm_mode_create_tile_group);