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